Merge pull request #1279 from edmorley/docs-fixes

Docs: Spelling corrections & markup tweaks

docs/source/2010-news.rst

@@ -22,7 +22,7 @@ Changelog - 2010
 -------------------
 
 * Add SERVER_SOFTWARE to the os.environ
-* Add support for django settings environement variable
+* Add support for django settings environment variable
 * Add support for logging configuration in Paster ini-files
 * Improve arbiter notification in asynchronous workers
 * Display the right error when a worker can't be used

docs/source/2012-news.rst

@@ -11,7 +11,7 @@ Changelog - 2012
 - add response arg for post_request hook
 - parse command line with argparse (replace deprecated optparse)
 - fix PWD detection in arbiter
-- miscellenaeous PEP8 fixes
+- miscellaneous PEP8 fixes
 
 0.16.1 / 2012-11-19
 -------------------

docs/source/2013-news.rst

@@ -76,7 +76,7 @@ service release.
 -------------------
 
 - optimize readline
-- make imports errors more visiblle when loading an app or a logging
+- make imports errors more visible when loading an app or a logging
   class
 - fix tornado worker: don't pass ssl options if there are none
 - fix PEP3333: accept only bytetrings in the response body

docs/source/2015-news.rst

@@ -54,7 +54,7 @@ Core
 - fix: make sure that a user is able to access to the logs after dropping a
   privilege (:issue:`1116`)
 - improvement: inherit the `Exception` class where it needs to be (:issue:`997`)
-- fix: make sure headers are always encodedas latin1 RFC 2616 (:issue:`1102`)
+- fix: make sure headers are always encoded as latin1 RFC 2616 (:issue:`1102`)
 - improvement: reduce arbiter noise (:issue:`1078`)
 - fix: don't close the unix socket when the worker exit (:issue:`1088`)
 - improvement: Make last logged worker count an explicit instance var (:issue:`1078`)
@@ -63,7 +63,7 @@ Core
 - fix: catch OSError as well as ValueError on race condition (:issue:`1052`)
 - improve support of ipv6 by backporting urlparse.urlsplit from Python 2.7 to
   Python 2.6.
-- fix: raise InvalidRequestLine when the line contains maliscious data
+- fix: raise InvalidRequestLine when the line contains malicious data
   (:issue:`1023`)
 - fix: fix argument to disable sendfile
 - fix: add gthread to the list of supported workers (:issue:`1011`)
@@ -76,7 +76,7 @@ Logging
 +++++++
 
 - add new parameters to access log (:issue:`1132`)
-- fix: make sure that files handles are correctly reopenebd on HUP
+- fix: make sure that files handles are correctly reopened on HUP
   (:issue:`627`)
 - include request URL in error message (:issue:`1071`)
 - get username in access logs (:issue:`1069`)

docs/source/2016-news.rst

@@ -12,11 +12,11 @@ Changelog - 2016
 Core & Logging
 ++++++++++++++
 
-- improvement of the binary upgrade behaviour using USR2: remove file lockin (:issue:`1270`)
+- improvement of the binary upgrade behaviour using USR2: remove file locking (:issue:`1270`)
 - add the ``--capture-output`` setting to capture stdout/stderr tot the log
 file (:issue:`1271`)
-- Allow disabling ``sendfile()`` via the `SENDFILE`` environment variable
-(:issue:`1252`
+- Allow disabling ``sendfile()`` via the ``SENDFILE`` environment variable
+(:issue:`1252`)
 - fix reload under pycharm (:issue:`1129`)
 
 Workers
@@ -32,10 +32,10 @@ Workers
 Core
 ++++
 
-- fix: Ensure response to HEAD request won't have message body  
+- fix: Ensure response to HEAD request won't have message body
 - fix: lock domain socket and remove on last arbiter exit (:issue:`1220`)
 - improvement: use EnvironmentError instead of socket.error (:issue:`939`)
-- add: new $FORWARDDED_ALLOW_IPS environment variable (:issue:`1205`)
+- add: new ``FORWARDDED_ALLOW_IPS`` environment variable (:issue:`1205`)
 - fix: infinite recursion when destroying sockets (:issue:`1219`)
 - fix: close sockets on shutdown (:issue:`922`)
 - fix: clean up sys.exc_info calls to drop circular refs (:issue:`1228`)
@@ -55,7 +55,7 @@ Logging
 
 - fix: log message for listener reloading (:issue:`1181`)
 - Let logging module handle traceback printing (:issue:`1201`)
-- improvement: 	Allow configuring logger_class with statsd_host (:issue:`1188`)
+- improvement: Allow configuring logger_class with statsd_host (:issue:`1188`)
 - fix: traceback formatting (:issue:`1235`)
 - fix: print error logs on stderr and access logs on stdout (:issue:`1184`)
 

docs/source/design.rst

@@ -123,7 +123,7 @@ as the application code will be shared among workers but loaded only in the
 worker processes (unlike when using the preload setting, which loads the code in
 the master process).
 
-.. note:: Under Python 2.x, uou need to install the 'futures' package to use
+.. note:: Under Python 2.x, you need to install the 'futures' package to use
    this feature.
 
 .. _Greenlets: https://github.com/python-greenlet/greenlet

docs/source/faq.rst

@@ -10,7 +10,7 @@ WSGI Bits
 How do I set SCRIPT_NAME?
 -------------------------
 
-By default ``SCRIPT_NAME`` is an empy string. The value could be set by
+By default ``SCRIPT_NAME`` is an empty string. The value could be set by
 setting ``SCRIPT_NAME`` in the environment or as an HTTP header.
 
 

docs/source/news.rst

@@ -8,11 +8,11 @@ Changelog
 Core & Logging
 ++++++++++++++
 
-- improvement of the binary upgrade behaviour using USR2: remove file lockin (:issue:`1270`)
+- improvement of the binary upgrade behaviour using USR2: remove file locking (:issue:`1270`)
 - add the ``--capture-output`` setting to capture stdout/stderr tot the log
 file (:issue:`1271`)
-- Allow disabling ``sendfile()`` via the `SENDFILE`` environment variable
-(:issue:`1252`
+- Allow disabling ``sendfile()`` via the ``SENDFILE`` environment variable
+(:issue:`1252`)
 - fix reload under pycharm (:issue:`1129`)
 
 Workers
@@ -28,10 +28,10 @@ Workers
 Core
 ++++
 
-- fix: Ensure response to HEAD request won't have message body  
-- fix: lock domain socket and remove on last arbiter exit (:issue:`#1220`)
+- fix: Ensure response to HEAD request won't have message body
+- fix: lock domain socket and remove on last arbiter exit (:issue:`1220`)
 - improvement: use EnvironmentError instead of socket.error (:issue:`939`)
-- add: new $FORWARDDED_ALLOW_IPS environment variable (:issue:`1205`)
+- add: new ``FORWARDDED_ALLOW_IPS`` environment variable (:issue:`1205`)
 - fix: infinite recursion when destroying sockets (:issue:`1219`)
 - fix: close sockets on shutdown (:issue:`922`)
 - fix: clean up sys.exc_info calls to drop circular refs (:issue:`1228`)
@@ -40,9 +40,9 @@ Core
 Workers
 +++++++
 
-- fix access logging in gaiohttp worker (:issue:`#1193`)
-- eventlet: handle QUIT in a new coroutine (:issue:`#1217`)
-- gevent: remove obsolete exception clauses in run (:issue:`#1218`)
+- fix access logging in gaiohttp worker (:issue:`1193`)
+- eventlet: handle QUIT in a new coroutine (:issue:`1217`)
+- gevent: remove obsolete exception clauses in run (:issue:`1218`)
 - tornado: fix extra "Server" response header (:issue:`1246`)
 - fix: unblock the wait loop under python 3.5 in sync worker (:issue:`1256`)
 
@@ -51,7 +51,7 @@ Logging
 
 - fix: log message for listener reloading (:issue:`1181`)
 - Let logging module handle traceback printing (:issue:`1201`)
-- improvement:  Allow configuring logger_class with statsd_host (:issue:`#1188`)
+- improvement: Allow configuring logger_class with statsd_host (:issue:`1188`)
 - fix: traceback formatting (:issue:`1235`)
 - fix: print error logs on stderr and access logs on stdout (:issue:`1184`)
 
@@ -98,7 +98,7 @@ Core
 
 - improvement: handle HaltServer in manage_workers (:issue:`1095`)
 - fix: Do not rely on sendfile sending requested count (:issue:`1155`)
-- fix: claridy --no-sendfile default (:issue:`1156`)
+- fix: clarify --no-sendfile default (:issue:`1156`)
 - fix: LoggingCatch sendfile failure from no file descriptor (:issue:`1160`)
 
 Logging
@@ -134,7 +134,7 @@ Core
 - fix: make sure that a user is able to access to the logs after dropping a
   privilege (:issue:`1116`)
 - improvement: inherit the `Exception` class where it needs to be (:issue:`997`)
-- fix: make sure headers are always encodedas latin1 RFC 2616 (:issue:`1102`)
+- fix: make sure headers are always encoded as latin1 RFC 2616 (:issue:`1102`)
 - improvement: reduce arbiter noise (:issue:`1078`)
 - fix: don't close the unix socket when the worker exit (:issue:`1088`)
 - improvement: Make last logged worker count an explicit instance var (:issue:`1078`)
@@ -143,7 +143,7 @@ Core
 - fix: catch OSError as well as ValueError on race condition (:issue:`1052`)
 - improve support of ipv6 by backporting urlparse.urlsplit from Python 2.7 to
   Python 2.6.
-- fix: raise InvalidRequestLine when the line contains maliscious data
+- fix: raise InvalidRequestLine when the line contains malicious data
   (:issue:`1023`)
 - fix: fix argument to disable sendfile
 - fix: add gthread to the list of supported workers (:issue:`1011`)
@@ -156,7 +156,7 @@ Logging
 +++++++
 
 - add new parameters to access log (:issue:`1132`)
-- fix: make sure that files handles are correctly reopenebd on HUP
+- fix: make sure that files handles are correctly reopened on HUP
   (:issue:`627`)
 - include request URL in error message (:issue:`1071`)
 - get username in access logs (:issue:`1069`)