summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean M. Collins <sean@coreitpro.com>2011-04-25 16:53:01 -0400
committerSean M. Collins <sean@coreitpro.com>2011-04-25 16:53:01 -0400
commit4bab8733bb9e8c7b8eaa49272846191a36608427 (patch)
tree9eaaf3d0e061f77ceec76ac3b19050ad4b94e33d
parent0a82127d568d0e8bff79c8bb1d8351ce742afedb (diff)
downloadbottle-4bab8733bb9e8c7b8eaa49272846191a36608427.tar.gz
Copy editing.
-rwxr-xr-xdocs/tutorial.rst18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
index 2167049..49ae00a 100755
--- a/docs/tutorial.rst
+++ b/docs/tutorial.rst
@@ -73,13 +73,13 @@ This tutorial assumes you have Bottle either `installed or copied <#installation
Whats happening here?
-1. First we import some bottle components. The :func:`route` decorator and the :func:`run` function.
+1. First we import some Bottle components. The :func:`route` decorator and the :func:`run` function.
2. The :func:`route` :term:`decorator` is used do bind a piece of code to an URL. In this example we want to answer requests to the ``/hello`` URL.
3. This function is the :term:`handler function` or :term:`callback` for the ``/hello`` route. It is called every time someone requests the ``/hello`` URL and is responsible for generating the page content.
4. In this example we simply return a string to the browser.
5. In the last line we start the actual HTTP server. The default is a development server running on 'localhost' port 8080 and serving requests until you hit :kbd:`Control-c`.
-This is it. Run this script, visit http://localhost:8080/hello and you will see "Hello World!" in your browser. Of cause this is a very simple example, but it shows the basic concept of how applications are built with bottle. Continue reading and you'll see what else is possible.
+This is it. Run this script, visit http://localhost:8080/hello and you will see "Hello World!" in your browser. Of cause this is a very simple example, but it shows the basic concept of how applications are built with Bottle. Continue reading and you'll see what else is possible.
.. rubric:: The Application Object
@@ -394,7 +394,7 @@ As mentioned above, cookies are easily forged by malicious clients. Bottle can c
else:
return "You are not logged in. Access denied."
-In addition, bottle automatically pickles and unpickles any data stored to signed cookies. This allows you to store any pickle-able object (not only strings) to cookies, as long as the pickled data does not exceed the 4kb limitation.
+In addition, Bottle automatically pickles and unpickles any data stored to signed cookies. This allows you to store any pickle-able object (not only strings) to cookies, as long as the pickled data does not exceed the 4kb limitation.
.. warning:: Signed cookies are not encrypted (the client can still see the content) and not copy-protected (the client can restore an old cookie). The main intention is to make pickling and unpickling save, not to store secret information at client side.
@@ -562,7 +562,7 @@ Plugins
.. versionadded:: 0.9
-Bottles core features cover most of the common use-cases, but as a micro-framework it has its limits. This is where "Plugins" come into play. They add missing functionality to the framework, integrate third party libraries or just automate some repetitive work.
+Bottle's core features cover most common use-cases, but as a micro-framework it has its limits. This is where "Plugins" come into play. Plugins add missing functionality to the framework, integrate third party libraries, or just automate some repetitive work.
We have a growing :doc:`/plugins/index` and most plugins are designed to be portable and re-usable across applications. The chances are high that your problem has already been solved and a ready-to-use plugin exists. If not, the :doc:`/plugindev` may help you.
@@ -667,9 +667,9 @@ Most plugins are specific to the application they were installed to. Consequentl
root.install(plugins.WTForms())
-Whenever you mount an application, bottle creates a proxy-route on the main-application that relays all requests to the sub-application. Plugins are disabled for this kind of proxy-routes by default. As a result, our (fictional) `WTForms` plugin affects the ``/contact`` route, but does not affect the routes of the ``/blog`` sub-application.
+Whenever you mount an application, Bottle creates a proxy-route on the main-application that relays all requests to the sub-application. Plugins are disabled for this kind of proxy-routes by default. As a result, our (fictional) `WTForms` plugin affects the ``/contact`` route, but does not affect the routes of the ``/blog`` sub-application.
-This is a sane default, but of cause you can change it. The following example re-activates all plugins for a specific proxy-route::
+This behavior is intended as a sane default, but can be overridden. The following example re-activates all plugins for a specific proxy-route::
root.mount(apps.blog, '/blog', skip=None)
@@ -739,7 +739,7 @@ During early development, the debug mode can be very helpful.
bottle.debug(True)
-In this mode, bottle is much more verbose and provides helpful debugging information whenever an error occurs. It also disables some optimisations that might get in your way and adds some checks that warn you about possible misconfiguration.
+In this mode, Bottle is much more verbose and provides helpful debugging information whenever an error occurs. It also disables some optimisations that might get in your way and adds some checks that warn you about possible misconfiguration.
Here is an incomplete list of things that change in debug mode:
@@ -789,7 +789,7 @@ Bottle runs on the built-in `wsgiref WSGIServer <http://docs.python.org/library/
There are three ways to eliminate this bottleneck:
* Use a multi-threaded or asynchronous HTTP server.
-* Spread the load between multiple bottle instances.
+* Spread the load between multiple Bottle instances.
* Do both.
@@ -811,7 +811,7 @@ Multi-Threaded Server
.. _meinheld: http://pypi.python.org/pypi/meinheld
.. _bjoern: http://pypi.python.org/pypi/bjoern
-The easiest way to increase performance is to install a multi-threaded or asynchronous WSGI server like paste_ or cherrypy_ and tell bottle to start it instead of the default single-threaded one::
+The easiest way to increase performance is to install a multi-threaded or asynchronous WSGI server like paste_ or cherrypy_ and tell Bottle to start it instead of the default single-threaded one::
bottle.run(server='paste') # Example