Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge pull request #26 from davidjb/master

Minor documentation updates for grammar
  • Loading branch information...
commit 3117b202b433dd6e409be9da9610e4bf027d7644 2 parents 50a525c + ec35627
@bbangert authored
View
12 beaker/docs/caching.rst
@@ -12,7 +12,7 @@ which was ported for use in `Myghty`_. Beaker was then extracted from this
code, and has been substantially rewritten and modernized.
Several concepts still exist from this origin though. Beaker's caching (and
-its sessions, though its behind the scenes) utilize the concept of
+its sessions, behind the scenes) utilize the concept of
:term:`NamespaceManager`, and :term:`Container` objects to handle storing
cached data.
@@ -110,7 +110,7 @@ All of the values for a particular namespace can be removed by calling the
tmpl_cache.clear()
Note that this only clears the key's in the namespace that this particular
-Cache instance is aware of. Therefore its recommend to manually clear out
+Cache instance is aware of. Therefore, it is recommended to manually clear out
specific keys in a cache namespace that should be removed::
tmpl_cache.remove_value(key=search_param)
@@ -125,7 +125,7 @@ When using the decorator API, a namespace does not need to be specified and
will instead be created for you with the name of the module + the name of the
function that will have its output cached.
-Since its possible that multiple functions in the same module might have the
+Since it's possible that multiple functions in the same module might have the
same name, additional arguments can be provided to the decorators that will be
used in the namespace to prevent multiple functions from caching their values
in the same location.
@@ -204,7 +204,7 @@ This can be useful if there are a few common cache schemes used by an
application that should be setup in a single place then used as appropriate
throughout the application.
-Setting up cache region's is documented in the
+Setting up cache regions is documented in the
:ref:`cache region options <cache_region_options>` section in
:ref:`configuration`.
@@ -230,7 +230,7 @@ Or using the :func:`~beaker.cache.cache_region` decorator::
results = get_results('gophers')
The only difference with the :func:`~beaker.cache.cache_region` decorator is
-that the cache does not need to be configured when its used. This allows one
+that the cache does not need to be configured when it is used. This allows one
to decorate functions in a module before the Beaker cache is configured.
Invalidating
@@ -256,4 +256,4 @@ Or when using the :func:`~beaker.cache.cache_region` decorator, the
to remove.
-.. _Myghty: http://www.myghty.org/
+.. _Myghty: http://www.myghty.org/
View
10 beaker/docs/configuration.rst
@@ -4,10 +4,10 @@
Configuration
=============
-Beaker can be configured several different ways, depending on how it's used.
-The most recommended style is to use a dictionary of preferences that are to
-be passed to either the :class:`~beaker.middleware.SessionMiddleware` or the
-:class:`~beaker.cache.CacheManager`.
+Beaker can be configured several different ways, depending on how it is to be
+used. The most recommended style is to use a dictionary of preferences that
+are to be passed to either the :class:`~beaker.middleware.SessionMiddleware` or
+the :class:`~beaker.cache.CacheManager`.
Since both Beaker's sessions and caching use the same back-end container
storage system, there's some options that are applicable to both of them in
@@ -139,7 +139,7 @@ auto (**optional**, bool)
Defaults to False.
-cookie_expires (**optional**, bool, datetime, timedelta, int)
+cookie_expires (**optional**, boob, datetime, timedelta, int)
Determines when the cookie used to track the client-side of the session
will expire. When set to a boolean value, it will either expire at the
end of the browsers session, or never expire.
View
4 beaker/docs/sessions.rst
@@ -117,7 +117,7 @@ saved should something catastrophic happen during a request.
**Order Matters**: When using the Beaker middleware, you **must call save before
the headers are sent to the client**. Since Beaker's middleware watches for when
the ``start_response`` function is called to know that it should add its cookie
-header, the session must be saved before its called.
+header, the session must be saved before it is called.
Keep in mind that Response objects in popular frameworks (WebOb, Werkzeug,
etc.) call start_response immediately, so if you are using one of those
@@ -149,7 +149,7 @@ Auto-save
Saves can be done automatically by setting the ``auto`` configuration option
for sessions. When set, calling the :meth:`~beaker.session.Session.save` method
-is no longer required, and the session will be saved automatically anytime its
+is no longer required, and the session will be saved automatically anytime it is
accessed during a request.
Please sign in to comment.
Something went wrong with that request. Please try again.