summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-09-07 16:02:53 -0400
committerChris McDonough <chrism@plope.com>2011-09-07 16:02:53 -0400
commit8a8c27d4699168818e942f4beba7b88740ae346b (patch)
treefd1450eb538bc8bdd9e243a965cb85d9334fbe38
parent77ef3b0d26357ba36f5577924b0bef0b3365d1a6 (diff)
downloadpyramid-8a8c27d4699168818e942f4beba7b88740ae346b.tar.gz
pyramid-8a8c27d4699168818e942f4beba7b88740ae346b.tar.bz2
pyramid-8a8c27d4699168818e942f4beba7b88740ae346b.zip
docstring gardening
-rw-r--r--pyramid/registry.py14
1 files changed, 8 insertions, 6 deletions
diff --git a/pyramid/registry.py b/pyramid/registry.py
index 390ae8841..93a7a8b46 100644
--- a/pyramid/registry.py
+++ b/pyramid/registry.py
@@ -3,12 +3,14 @@ from zope.component.registry import Components
from pyramid.interfaces import ISettings
class Registry(Components, dict):
- """ A registry object is an :term:`application registry`. The existence
- of a registry implementation detail of :app:`pyramid`. It is used by the
- framework itself to perform mappings of URLs to view callables, as well
- as servicing other various duties. Despite being an implementation detail
- of the framework, it has a number of attributes that may be useful within
- application code.
+ """ A registry object is an :term:`application registry`. It is used by
+ the framework itself to perform mappings of URLs to view callables, as
+ well as servicing other various framework duties. A registry has its own
+ internal API, but this API is rarely used by Pyramid application
+ developers (usually obly by developers of the Pyramid framework). But it
+ has a number of attributes that may be useful to application developers
+ within application code, such as ``settings``, which is a dictionary
+ containing application deployment settings.
For information about the purpose and usage of the application registry,
see :ref:`zca_chapter`.