summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLawouach <sh@defuze.org>2014-05-24 14:48:21 +0200
committerLawouach <sh@defuze.org>2014-05-24 14:48:21 +0200
commitc7fd9953150f37764cc0ee7e1c43f834e9845c57 (patch)
tree5bedc36125fbf5fc467d4c8f96ce9b23742b92f2
parente2dee6509a0f4d245ec08b53f637772918f90a69 (diff)
downloadcherrypy-c7fd9953150f37764cc0ee7e1c43f834e9845c57.tar.gz
typos
-rw-r--r--sphinx/source/advanced.rst12
-rw-r--r--sphinx/source/basics.rst36
2 files changed, 24 insertions, 24 deletions
diff --git a/sphinx/source/advanced.rst b/sphinx/source/advanced.rst
index 8b1b0e6e..44f54edb 100644
--- a/sphinx/source/advanced.rst
+++ b/sphinx/source/advanced.rst
@@ -155,7 +155,7 @@ The popargs decorator
^^^^^^^^^^^^^^^^^^^^^
:func:`cherrypy.popargs` is more straightforward as it gives a name to any segment
that CherryPy wouldn't be able to interpret otherwise. This makes the
-matching of segments with page handler signatures easier and help CherryPy
+matching of segments with page handler signatures easier and helps CherryPy
understand the structure of your URL.
.. code-block:: python
@@ -254,7 +254,7 @@ available.
Once CherryPy has set the status and headers, it sends them to the HTTP server,
which then writes them out to the client. From that point on, the CherryPy
-ramework mostly steps out of the way, and the HTTP server essentially requests
+framework mostly steps out of the way, and the HTTP server essentially requests
content directly from your application code (your page handler method).
Therefore, when streaming, if an error occurs within your page handler,
@@ -486,7 +486,7 @@ as well as its updates in :pep:`3333`. It means the following:
Make your CherryPy application a WSGI application
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A WSGI application can be obtained from your application as follow:
+A WSGI application can be obtained from your application as follows:
.. code-block:: python
@@ -592,13 +592,13 @@ makes it easy to integrate one. Popular ones are `Mako <www.makotemplates.org>`_
or `Jinja2 <jinja.pocoo.org/docs/>`_.
You will find `here <https://bitbucket.org/Lawouach/cherrypy-recipes/src/tip/web/templating/>`_
-a recipe on how integrating them using a mix
+a recipe on how to integrate them using a mix
:ref:`plugins <busplugins>` and :ref:`tools <tools>`.
Testing your application
########################
-Web application, like any other kind of code, must be tested. CherryPy provides
+Web applications, like any other kind of code, must be tested. CherryPy provides
a :class:`helper class <cherrypy.test.helper.CPWebCase>` to ease writing
functional tests.
@@ -646,7 +646,7 @@ tests and call the helper :meth:`~cherrypy.test.helper.CPWebCase.getPage`
method to perform a request. Simply use the various specialized
assert* methods to validate your workflow and data.
-You can then run the test using `py.test <http://pytest.org/latest/>`_ as follow:
+You can then run the test using `py.test <http://pytest.org/latest/>`_ as follows:
.. code-block:: bash
diff --git a/sphinx/source/basics.rst b/sphinx/source/basics.rst
index 99199f0c..8129fc45 100644
--- a/sphinx/source/basics.rst
+++ b/sphinx/source/basics.rst
@@ -123,7 +123,7 @@ Multiple applications
The :func:`cherrypy.quickstart` approach is fine for a single application,
but lacks the capacity to host several applications with the server.
To achieve this, one must use the :meth:`cherrypy.tree.mount <cherrypy._cptree.Tree.mount>`
-function as follow:
+function as follows:
.. code-block:: python
@@ -207,7 +207,7 @@ To disable, console logging, set ``log.screen`` to `False`.
Play along with your other loggers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Your application may aobviously already use the :mod:`logging`
+Your application may obviously already use the :mod:`logging`
module to trace application level messages. CherryPy will not
interfere with them as long as your loggers are explicitely
named. This would work nicely:
@@ -249,7 +249,7 @@ method.
cherrypy.config.update({'server.socket_port': 9090})
The :mod:`cherrypy.config <cherrypy._cpconfig>` object is a dictionary and the
-update method merge the passed dictionary into it.
+update method merges the passed dictionary into it.
You can also pass a file instead (assuming a `server.conf`
file):
@@ -266,7 +266,7 @@ file):
.. warning::
:meth:`cherrypy.config.update() <cherrypy._cpconfig.Config.update>`
- is not mean to be used to configure the application.
+ is not meant to be used to configure the application.
It is a common mistake. It is used to configure the server and engine.
.. _perappconf:
@@ -274,8 +274,8 @@ file):
Per-application configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-To configure your application, pass a dictionary or a file
-when you associate ther application to the server.
+To configure your application, pass in a dictionary or a file
+when you associate their application to the server.
.. code-block:: python
@@ -321,7 +321,7 @@ Additional application settings
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can add settings that are not specific to a request URL
-and retrieve them from your page handler as follow:
+and retrieve them from your page handler as follows:
.. code-block:: ini
@@ -402,7 +402,7 @@ Extended example:
Using sessions
##############
-Sessions is one of the most common mechanism used by developers to
+Sessions are one of the most common mechanism used by developers to
identify users and synchronize their activity. By default, CherryPy
does not activate sessions because it is not a mandatory feature
to have, to enable it simply add the following settings in your
@@ -421,7 +421,7 @@ Sessions are, by default, stored in RAM so, if you restart your server
all of your current sessions will be lost. You can store them in memcached
or on the filesystem instead.
-Using sessions in your applications is done as follow:
+Using sessions in your applications is done as follows:
.. code-block:: python
@@ -445,12 +445,12 @@ the storage.
Refer to the :mod:`cherrypy.lib.sessions` module for more
details about the session interface and implementation.
- Notabley you will learn about sessions expiricy.
+ Notably you will learn about sessions expiration.
Filesystem backend
^^^^^^^^^^^^^^^^^^
-Using a filesystem is a simple not to lose your sessions
+Using a filesystem is a simple to not lose your sessions
between reboots. Each session is saved in its own file within
the given directory.
@@ -486,7 +486,7 @@ CSS resources, etc.
CherryPy uses the :mod:`mimetypes` module to determine the
best content-type to serve a particular resource. If the choice
- is not valid, you can simply set more media-types as follow:
+ is not valid, you can simply set more media-types as follows:
.. code-block:: python
@@ -497,7 +497,7 @@ CSS resources, etc.
Serving a single file
^^^^^^^^^^^^^^^^^^^^^
-You can serve a single file as follow:
+You can serve a single file as follows:
.. code-block:: ini
@@ -527,7 +527,7 @@ CherryPy will automatically respond to URLs such as
.. note::
CherryPy always requires the absolute path to the files or directories
- it will serve. If you have several static section to configure
+ it will serve. If you have several static sections to configure
but located in the same root directory, you can use the following
shortcut:
@@ -548,7 +548,7 @@ Using ``"application/x-download"`` response content-type,
you can tell a browser that a resource should be downloaded
onto the user's machine rather than displayed.
-You could for instance write a page handler as follow:
+You could for instance write a page handler as follows:
.. code-block:: python
@@ -572,7 +572,7 @@ the browser.
Dealing with JSON
#################
-CherryPy has a built-in support for JSON encoding and decoding
+CherryPy has built-in support for JSON encoding and decoding
of the request and/or response.
Decoding request
@@ -611,7 +611,7 @@ encoded.
Authentication
##############
-CherryPy provides support for two very simple authentications mechanism,
+CherryPy provides support for two very simple authentication mechanisms,
both described in :rfc:`2617`: Basic and Digest. They are most commonly
known to trigger a browser's popup asking users their name
and password.
@@ -685,7 +685,7 @@ Favicon
CherryPy serves its own sweet red cherrypy as the default
`favicon <http://en.wikipedia.org/wiki/Favicon>`_ using the static file
-tool. You can serve your own favicon as follow:
+tool. You can serve your own favicon as follows:
.. code-block:: python