diff options
author | Marcel Hellkamp <marc@gsites.de> | 2012-10-09 17:12:39 +0200 |
---|---|---|
committer | Marcel Hellkamp <marc@gsites.de> | 2012-10-09 17:14:01 +0200 |
commit | be36389a1832f124986dd45b2adff3cd1e4f8ece (patch) | |
tree | ba01121bda1aad7b4f0bd3bed2027a72fb34a368 | |
parent | e52b2be25ebed31af7208a37ee47161ed7d5f193 (diff) | |
download | bottle-be36389a1832f124986dd45b2adff3cd1e4f8ece.tar.gz |
Mostly typos in docs
-rw-r--r-- | bottle.py | 6 | ||||
-rwxr-xr-x | docs/api.rst | 4 | ||||
-rwxr-xr-x | docs/changelog.rst | 2 | ||||
-rw-r--r-- | docs/deployment.rst | 7 |
4 files changed, 12 insertions, 7 deletions
@@ -519,10 +519,10 @@ class Bottle(object): #: If true, most exceptions are caught and returned as :exc:`HTTPError` self.catchall = catchall - #: A :cls:`ResourceManager` for application files + #: A :class:`ResourceManager` for application files self.resources = ResourceManager() - #: A :cls:`ConfigDict` for app specific configuration. + #: A :class:`ConfigDict` for app specific configuration. self.config = ConfigDict() self.config.autojson = autojson @@ -1838,7 +1838,7 @@ class WSGIHeaderDict(DictMixin): Currently PEP 333, 444 and 3333 are supported. (PEP 444 is the only one that uses non-native strings.) ''' - #: List of keys that do not have a 'HTTP_' prefix. + #: List of keys that do not have a ``HTTP_`` prefix. cgikeys = ('CONTENT_TYPE', 'CONTENT_LENGTH') def __init__(self, environ): diff --git a/docs/api.rst b/docs/api.rst index 8322dc3..aeb4ff0 100755 --- a/docs/api.rst +++ b/docs/api.rst @@ -130,7 +130,7 @@ The :class:`Request` class wraps a WSGI environment and provides helpful methods .. autoclass:: BaseRequest :members: -The module-level :data:`bottle.request` is a proxy object (implemented in :cls:`LocalRequest`) and always refers to the `current` request, or in other words, the request that is currently processed by the request handler in the current thread. This `thread locality` ensures that you can safely use a global instance in a multi-threaded environment. +The module-level :data:`bottle.request` is a proxy object (implemented in :class:`LocalRequest`) and always refers to the `current` request, or in other words, the request that is currently processed by the request handler in the current thread. This `thread locality` ensures that you can safely use a global instance in a multi-threaded environment. .. autoclass:: LocalRequest :members: @@ -151,7 +151,7 @@ The :class:`Response` class stores the HTTP status code as well as headers and c :members: -The following two classes can be raised as an exception. The most noticeable difference is that bottle invokes error handlers for :cls:`HTTPError`, but not for :cls:`HTTPResponse` or other response types. +The following two classes can be raised as an exception. The most noticeable difference is that bottle invokes error handlers for :class:`HTTPError`, but not for :class:`HTTPResponse` or other response types. .. autoexception:: HTTPResponse :members: diff --git a/docs/changelog.rst b/docs/changelog.rst index dbe387f..44a37f4 100755 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -12,7 +12,7 @@ Release 0.11 * Native support for Python 2.x and 3.x syntax. No need to run 2to3 anymore. * Support for partial downloads (``Range`` header) in :func:`static_file`. -* The new :class:`ResourceManager` interface helps locating files bundled with the application. +* The new :class:`ResourceManager` interface helps locating files bundled with an application. * Added a server adapter for `waitress <http://docs.pylonsproject.org/projects/waitress/en/latest/>`_. * New :meth:`Bottle.merge` method to install all routes from one application into another. * New :attr:`BaseRequest.app` property to get the application object that handles a request. diff --git a/docs/deployment.rst b/docs/deployment.rst index d97fcb1..7371ac2 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -14,6 +14,11 @@ .. _gevent: http://www.gevent.org/ .. _eventlet: http://eventlet.net/ .. _waitress: http://readthedocs.org/docs/waitress/en/latest/ +.. _apache: http://httpd.apache.org/ +.. _mod_wsgi: http://code.google.com/p/modwsgi/ +.. _pound: http://www.apsis.ch/pound + + .. _tutorial-deployment: @@ -87,7 +92,7 @@ If there is no adapter for your favorite server or if you need more control over Apache mod_wsgi -------------------------------------------------------------------------------- -Instead of running your own HTTP server from within Bottle, you can attach Bottle applications to an `Apache server`_ using mod_wsgi_. +Instead of running your own HTTP server from within Bottle, you can attach Bottle applications to an `Apache server <apache>`_ using mod_wsgi_. All you need is an ``app.wsgi`` file that provides an ``application`` object. This object is used by mod_wsgi to start your application and should be a WSGI-compatible Python callable. |