summaryrefslogtreecommitdiffstats
path: root/development/epydoc/slack-desc
diff options
context:
space:
mode:
author dsomero <xgizzmo@slackbuilds.org>2013-11-22 02:29:22 -0500
committer dsomero <xgizzmo@slackbuilds.org>2013-11-22 02:29:22 -0500
commit610e8461bb9b201adbd4bd9257a9bf48be71f62b (patch)
tree6ca569349369dbaa4ba6c24795d6201303b9d2fa /development/epydoc/slack-desc
parent8fe2e3d82e774b981c041e043ca2f71ed672b493 (diff)
downloadslackbuilds-610e8461bb9b201adbd4bd9257a9bf48be71f62b.tar.gz
slackbuilds-610e8461bb9b201adbd4bd9257a9bf48be71f62b.tar.xz
various: Fix slack-desc formatting and comment nit picks.
Signed-off-by: dsomero <xgizzmo@slackbuilds.org>
Diffstat (limited to 'development/epydoc/slack-desc')
-rw-r--r--development/epydoc/slack-desc14
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