Skip to content

Commit

Permalink
Improved package documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
nadako committed Feb 2, 2009
1 parent 84e6538 commit 313348b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
18 changes: 10 additions & 8 deletions README.txt
@@ -1,10 +1,12 @@
Traversers are Zope's mechanism to convert URI paths to an object of the
application. They provide an extremly flexible mechanism to make decisions
based on the policies of the application. Unfortunately the default traverser
implementation is not flexible enough to deal with arbitrary extensions (via
adapters) of objects that also wish to participate in the traversal decision
process.

The pluggable traverser allows developers, especially third-party developers,
This package provides the pluggable traverser mechanism allowing developers
to add new traversers to an object without altering the original traversal
implementation.

In addition to the pluggable traversers, this package contains two more
subpackages:

* viewlet - provides a way to traverse to viewlets using namespaces

* stackinfo - provides a way to consume parts of url and store them
as attributes of the "consumer" object. Useful for urls like:
/blog/2009/02/02/hello-world
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -25,7 +25,7 @@ def read(*rnames):
version = '0.2.4dev',
author='Zope Corporation and Contributors',
author_email='zope-dev@zope.org',
description='Pluggable Traverser API',
description='Pluggable Traversers And URL handling utilities',
long_description=(
read('README.txt')
+ '\n\n' +
Expand Down

0 comments on commit 313348b

Please sign in to comment.