[Checkins] SVN: zope.contentprovider/trunk/ Clean up package's description and documentation a bit. Remove duplicate text in README.

Dan Korostelev nadako at gmail.com
Tue Mar 17 16:54:50 EDT 2009


Log message for revision 98211:
  Clean up package's description and documentation a bit. Remove duplicate text in README.
  

Changed:
  U   zope.contentprovider/trunk/CHANGES.txt
  U   zope.contentprovider/trunk/README.txt
  U   zope.contentprovider/trunk/setup.py
  U   zope.contentprovider/trunk/src/zope/contentprovider/README.txt

-=-
Modified: zope.contentprovider/trunk/CHANGES.txt
===================================================================
--- zope.contentprovider/trunk/CHANGES.txt	2009-03-17 17:31:53 UTC (rev 98210)
+++ zope.contentprovider/trunk/CHANGES.txt	2009-03-17 20:54:50 UTC (rev 98211)
@@ -15,8 +15,12 @@
 
 - Added setuptools dependency to setup.py.
 
-- Change mailing list address to zope-dev at zope.org instead of retired one.
+- Clean up package's description and documentation a bit. Remove
+  duplicate text in README.
 
+- Change mailing list address to zope-dev at zope.org instead of
+  retired one.
+
 - Change ``cheeseshop`` to ``pypi`` in the package url.
 
 3.4.0 (2007-10-02)

Modified: zope.contentprovider/trunk/README.txt
===================================================================
--- zope.contentprovider/trunk/README.txt	2009-03-17 17:31:53 UTC (rev 98210)
+++ zope.contentprovider/trunk/README.txt	2009-03-17 20:54:50 UTC (rev 98211)
@@ -1,12 +1 @@
-====================
-zope.contentprovider
-====================
-
-Overview
---------
-
-This package provides a framework to develop componentized Web GUI
-applications. Instead of describing the content of a page using a single
-template or static system of templates and METAL macros, content provider
-objects are dynamically looked up based on the setup/configuration of the
-application.
+See src/zope/contentprovider/README.txt.

Modified: zope.contentprovider/trunk/setup.py
===================================================================
--- zope.contentprovider/trunk/setup.py	2009-03-17 17:31:53 UTC (rev 98210)
+++ zope.contentprovider/trunk/setup.py	2009-03-17 20:54:50 UTC (rev 98211)
@@ -25,10 +25,8 @@
       version = '3.4.1dev',
       author='Zope Corporation and Contributors',
       author_email='zope-dev at zope.org',
-      description='Zope Content Providers',
+      description='Content Provider Framework for Zope Templates',
       long_description=(
-          read('README.txt')
-          + '\n\n' +
           read('src', 'zope', 'contentprovider', 'README.txt')
           + '\n\n' +
           read('CHANGES.txt')

Modified: zope.contentprovider/trunk/src/zope/contentprovider/README.txt
===================================================================
--- zope.contentprovider/trunk/src/zope/contentprovider/README.txt	2009-03-17 17:31:53 UTC (rev 98210)
+++ zope.contentprovider/trunk/src/zope/contentprovider/README.txt	2009-03-17 20:54:50 UTC (rev 98211)
@@ -8,9 +8,8 @@
 objects are dynamically looked up based on the setup/configuration of the
 application.
 
-  >>> from zope.contentprovider import interfaces
+.. contents::
 
-
 Motivation and Design Goals
 ---------------------------
 
@@ -101,6 +100,8 @@
 prepared and, if applicable, any data, the provider is responsible for, is
 updated.
 
+  >>> from zope.contentprovider import interfaces
+
 So let's create a simple content provider:
 
   >>> import zope.interface
@@ -565,10 +566,7 @@
 You might also want to look at the ``zope.viewlet`` package for a more
 featureful API.
 
+Let's remove all temporary data we created during this README.
 
-Cleanup
--------
-
   >>> import shutil
   >>> shutil.rmtree(temp_dir)
-



More information about the Checkins mailing list