[Checkins] SVN: zope.interface/trunk/ Fix formatting. Improve package description. Add changelog entries.

[Dan Korostelev]

Log message for revision 97406:
  Fix formatting. Improve package description. Add changelog entries.

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

-=-
Modified: zope.interface/trunk/CHANGES.txt
===================================================================
--- zope.interface/trunk/CHANGES.txt	2009-03-01 21:44:01 UTC (rev 97405)
+++ zope.interface/trunk/CHANGES.txt	2009-03-01 22:20:07 UTC (rev 97406)
@@ -1,19 +1,26 @@
-*******
 CHANGES
 *******
 
+==================
 3.5.1 (unreleased)
-------------------
+==================
 
 - verifyObject: use getattr instead of hasattr to test for object attributes
   in order to let exceptions other than AttributeError raised by properties
   propagate to the caller
 
-- Add Sphinx-based documentation building to the package buildout configuration.
+- Add Sphinx-based documentation building to the package buildout
+  configuration. Use the ``bin/docs`` command after buildout.
 
+- Improve package description a bit. Unify changelog entries formatting.
 
+- Change package's mailing list address to zope-dev at zope.org as
+  zope3-dev at zope.org is now retired.
+
+
+==================
 3.5.0 (2008-10-26)
-------------------
+==================
 
 - Fixed declaration of _zope_interface_coptimizations, it's not a top level
   package.
@@ -32,39 +39,45 @@
   it 3x faster.
 
 
+==================
 3.4.1 (2007-10-02)
-------------------
+==================
 
 - Fixed a setup bug that prevented installation from source on systems
   without setuptools.
 
 
+==================
 3.4.0 (2007-07-19)
-------------------
+==================
 
 - Final release for 3.4.0.
 
 
+====================
 3.4.0b3 (2007-05-22)
---------------------
+====================
 
+
 - Objects with picky custom comparison methods couldn't be added to
   component registries.  Now, when checking whether an object is
   already registered, identity comparison is used.
 
 
+====================
 3.3.0.1 (2007-01-03)
---------------------
+====================
 
 - Made a reference to OverflowWarning, which disappeared in Python
   2.5, conditional.
 
 
+==================
 3.3.0 (2007/01/03)
-------------------
+==================
 
 New Features
-~~~~~~~~~~~~
+============
 
 - The adapter-lookup algorithim was refactored to make it
   much simpler and faster.  
@@ -84,33 +97,37 @@
   zope.interface.taggedValue).
 
 Bug Fixes
-~~~~~~~~~
+=========
 
 - A bug in multi-adapter lookup sometimes caused incorrect adapters to
   be returned.
 
 
+====================
 3.2.0.2 (2006-04-15)
---------------------
+====================
 
 - Fix packaging bug:  'package_dir' must be a *relative* path.
 
 
+====================
 3.2.0.1 (2006-04-14)
---------------------
+====================
 
 - Packaging change:  suppress inclusion of 'setup.cfg' in 'sdist' builds.
 
 
+==================
 3.2.0 (2006-01-05)
-------------------
+==================
 
 - Corresponds to the verison of the zope.interface package shipped as part of
   the Zope 3.2.0 release.
 
 
+==================
 3.1.0 (2005-10-03)
-------------------
+==================
 
 - Corresponds to the verison of the zope.interface package shipped as part of
   the Zope 3.1.0 release.
@@ -122,8 +139,9 @@
   favor of 'implementedBy' and 'providedBy'.
 
 
+==================
 3.0.1 (2005-07-27)
-------------------
+==================
 
 - Corresponds to the verison of the zope.interface package shipped as part of
   the Zope X3.0.1 release.
@@ -132,8 +150,9 @@
   to fail occasionally to reflect declaration changes.
 
 
+==================
 3.0.0 (2004-11-07)
-------------------
+==================
 
 - Corresponds to the verison of the zope.interface package shipped as part of
   the Zope X3.0.0 release.

Modified: zope.interface/trunk/README.txt
===================================================================
--- zope.interface/trunk/README.txt	2009-03-01 21:44:01 UTC (rev 97405)
+++ zope.interface/trunk/README.txt	2009-03-01 22:20:07 UTC (rev 97406)
@@ -2,7 +2,11 @@
 Zope Interfaces
 ***************
 
+This package provides an implementation of `object interfaces` for Python.
+Interfaces are a mechanism for labeling objects as conforming to a given
+API or contract. So, this package can be considered as implementation of
+the `Design By Contract`_ methodology support in Python.
+
+.. _Design By Contract: http://en.wikipedia.org/wiki/Design_by_contract
+
 .. contents::
-
-Interfaces are a mechanism for labeling objects as conforming to a given
-API or contract.

Modified: zope.interface/trunk/setup.py
===================================================================
--- zope.interface/trunk/setup.py	2009-03-01 21:44:01 UTC (rev 97405)
+++ zope.interface/trunk/setup.py	2009-03-01 22:20:07 UTC (rev 97406)
@@ -25,6 +25,8 @@
     from setuptools import setup, Extension, Feature
     from setuptools.command.build_ext import build_ext
 except ImportError, e:
+    # do we need to support plain distutils for building when even
+    # the package itself requires setuptools for installing?
     from distutils.core import setup, Extension
     from distutils.command.build_ext import build_ext
 
@@ -77,7 +79,7 @@
         read('CHANGES.txt')
         + '\n' +
         'Download\n'
-        '**********************\n'
+        '********\n'
         )
 
 

Modified: zope.interface/trunk/src/zope/interface/verify.txt
===================================================================
--- zope.interface/trunk/src/zope/interface/verify.txt	2009-03-01 21:44:01 UTC (rev 97405)
+++ zope.interface/trunk/src/zope/interface/verify.txt	2009-03-01 22:20:07 UTC (rev 97406)
@@ -15,7 +15,7 @@
 Verifying objects
 =================
 
-An object provides an interface iff
+An object provides an interface if
 
 - either its class declares that it implements the interfaces, or the object
   declares that it directly provides the interface