Revision: 330
Author: roman_yakovenko
Date: 2006-07-20 04:12:54 -0700 (Thu, 20 Jul 2006)
ViewCVS: http://svn.sourceforge.net/pygccxml/?rev=330&view=rev
Log Message:
-----------
adding request for help
Modified Paths:
--------------
pyplusplus_dev/docs/documentation/index.rest
Modified: pyplusplus_dev/docs/documentation/index.rest
===================================================================
--- pyplusplus_dev/docs/documentation/index.rest 2006-07-20 07:15:20 UTC (rev 329)
+++ pyplusplus_dev/docs/documentation/index.rest 2006-07-20 11:12:54 UTC (rev 330)
@@ -1,20 +1,29 @@
-=============
-Documentation
-=============
+========================
+pyplusplus documentation
+========================
.. contents:: Table of contents
-----
-XXXX
-----
+------------
+Help needed!
+------------
- ???
+`pyplusplus`_ documentation is always under active development. It is not an easy
+task to create and maintain it. I will appriciate any help!
+How can you help?
-.. _`STL Containers` : ./containers.html
-
+* Lets face it: today it is not possible to use `pyplusplus`_ without looking
+ into source code. `pyplusplus`_ uses `Epydoc`_ to generate documentation from
+ source files. So, if you found some undocumented piece of code and you understand
+ what it does, please write documentation string and send it to me.
+
+* You are reading documentation and my English cause you to scream? Please, fix
+ those errors and send me new version of document. I will integrate the changes.
+
+.. _`Epydoc` : http://epydoc.sourceforge.net/
.. _`pyplusplus` : ./../pyplusplus.html
.. _`boost.python`: http://www.boost.org/libs/python/doc/index.html
.. _`Python`: http://www.python.org
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|