diff --git a/cheroot/cli.py b/cheroot/cli.py index f3c0504462..1ba4995761 100644 --- a/cheroot/cli.py +++ b/cheroot/cli.py @@ -19,6 +19,10 @@ # Start a server on the abstract UNIX socket CherootServer cheroot myapp.wsgi --bind @CherootServer + +.. spelling:: + + cli """ import argparse diff --git a/cheroot/connections.py b/cheroot/connections.py index b230307cb2..cc4522dd9b 100644 --- a/cheroot/connections.py +++ b/cheroot/connections.py @@ -74,9 +74,8 @@ def __init__(self, server): def put(self, conn): """Put idle connection into the ConnectionManager to be managed. - Args: - conn (cheroot.server.HTTPConnection): HTTP connection - to be managed. + :param conn: HTTP connection to be managed + :type conn: cheroot.server.HTTPConnection """ conn.last_used = time.time() # if this conn doesn't have any more data waiting to be read, @@ -119,9 +118,8 @@ def get_conn(self): # noqa: C901 # FIXME Any connection returned by this method will need to be `put` back if it should be examined again for another request. - Returns: - cheroot.server.HTTPConnection instance, or None. - + :returns: HTTPConnection instance, or None + :rtype: cheroot.server.HTTPConnection """ # return a readable connection if any exist with suppress(IndexError): diff --git a/cheroot/ssl/pyopenssl.py b/cheroot/ssl/pyopenssl.py index 14d238e603..adc9a1bacb 100644 --- a/cheroot/ssl/pyopenssl.py +++ b/cheroot/ssl/pyopenssl.py @@ -44,6 +44,10 @@ ` is :py:data:`None`, but ``.private_key`` and ``.certificate`` are both given and valid, they will be read, and the context will be automatically created from them. + +.. spelling:: + + pyopenssl """ from __future__ import absolute_import, division, print_function diff --git a/cheroot/test/test_cli.py b/cheroot/test/test_cli.py index 62c35afbf8..6e0e6441be 100644 --- a/cheroot/test/test_cli.py +++ b/cheroot/test/test_cli.py @@ -1,4 +1,9 @@ -"""Tests to verify the command line interface.""" +"""Tests to verify the command line interface. + +.. spelling:: + + cli +""" # -*- coding: utf-8 -*- # vim: set fileencoding=utf-8 : import sys @@ -34,7 +39,7 @@ def test_parse_wsgi_bind_addr(raw_bind_addr, expected_bind_addr): """Check the parsing of the --bind option. - Verify some of the supported addresses and the excpected return value. + Verify some of the supported addresses and the expected return value. """ assert parse_wsgi_bind_addr(raw_bind_addr) == expected_bind_addr diff --git a/cheroot/test/webtest.py b/cheroot/test/webtest.py index 51506ef60d..cdd340e859 100644 --- a/cheroot/test/webtest.py +++ b/cheroot/test/webtest.py @@ -124,7 +124,7 @@ class WebCase(unittest.TestCase): def _Conn(self): """Return HTTPConnection or HTTPSConnection based on self.scheme. - * from http.client. + * from :py:mod:`python:http.client`. """ cls_name = '{scheme}Connection'.format(scheme=self.scheme.upper()) return getattr(http_client, cls_name) diff --git a/cheroot/workers/threadpool.py b/cheroot/workers/threadpool.py index 6e6c721d90..915934ccea 100644 --- a/cheroot/workers/threadpool.py +++ b/cheroot/workers/threadpool.py @@ -1,4 +1,9 @@ -"""A thread-based worker pool.""" +"""A thread-based worker pool. + +.. spelling:: + + joinable +""" from __future__ import absolute_import, division, print_function __metaclass__ = type diff --git a/cheroot/wsgi.py b/cheroot/wsgi.py index 9ed949c6f0..6635f5288c 100644 --- a/cheroot/wsgi.py +++ b/cheroot/wsgi.py @@ -194,7 +194,7 @@ def _encode_status(status): According to :pep:`3333`, when using Python 3, the response status and headers must be bytes masquerading as Unicode; that is, they must be of type "str" but are restricted to code points in the - "latin-1" set. + "Latin-1" set. """ if six.PY2: return status diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 9b872b9f3f..795c867e82 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -45,6 +45,7 @@ ssl stdout subclasses submodules +subpackages syscall systemd threadpool