[svn r37264] create the new development trunk

--HG--
branch : trunk
This commit is contained in:
hpk
2007-01-24 15:24:01 +01:00
commit 5992a8ef21
435 changed files with 58640 additions and 0 deletions

19
py/doc/api.txt Normal file
View File

@@ -0,0 +1,19 @@
The py lib API
==============
This is a placeholder for upcoming API documentation. We
intend to mostly generate this API description from the py
lib's entry points, their docstrings and cross-reference it
with its tests and examples that are already available
at our little `getting started`_ chapter.
Your tests are your API insurance
=================================
Tests are the primary assurance of API compatilibity. If you
would like to ensure some behaviour gets preserved across major
releases you have to write a test. Note though, that the
documentation may state additional restrictions which
take precedence.
.. _`getting started`: getting-started.html