diff options
Diffstat (limited to 'development/epydoc')
-rw-r--r-- | development/epydoc/slack-desc | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/development/epydoc/slack-desc b/development/epydoc/slack-desc index 928224f42b..2563482149 100644 --- a/development/epydoc/slack-desc +++ b/development/epydoc/slack-desc @@ -1,13 +1,13 @@ # HOW TO EDIT THIS FILE: -# The "handy ruler" below makes it easier to edit a package description. Line -# up the first '|' above the ':' following the base package name, and the '|' on -# the right side marks the last column you can put a character in. You must make -# exactly 11 lines for the formatting to be correct. It's also customary to -# leave one space after the ':'. +# The "handy ruler" below makes it easier to edit a package description. +# Line up the first '|' above the ':' following the base package name, and +# the '|' on the right side marks the last column you can put a character in. +# You must make exactly 11 lines for the formatting to be correct. It's also +# customary to leave one space after the ':' except on otherwise blank lines. |-----handy-ruler------------------------------------------------------| epydoc: epydoc (python api documentation tool) -epydoc: +epydoc: epydoc: Epydoc is a tool for generating API documentation for Python modules, epydoc: based on their docstrings. For an example of epydoc's output, see epydoc: the API documentation for epydoc itself (html, pdf). A lightweight @@ -15,6 +15,6 @@ epydoc: markup language called epytext can be used to format docstrings, epydoc: and to add information about specific fields, such as parameters and epydoc: instance variables. Epydoc also understands docstrings written in epydoc: reStructuredText, Javadoc, and plaintext. -epydoc: +epydoc: epydoc: Home page: http://epydoc.sf.net |