diff options
| author | W. Trevor King <wking@drexel.edu> | 2010-02-06 16:53:57 -0500 |
|---|---|---|
| committer | W. Trevor King <wking@drexel.edu> | 2010-02-06 16:53:57 -0500 |
| commit | 413626d3b77e9bf89389a272ed489da29f3d9877 (patch) | |
| tree | 1595551db2db9f590f2bf36dfbae305a1e616c40 /libbe | |
| parent | 4c71190ebafd7ce198a5c0047588c4b2f7e5ef58 (diff) | |
| download | bugseverywhere-413626d3b77e9bf89389a272ed489da29f3d9877.tar.gz | |
Use numpydoc and generate-libbe-txt.py to autogenerate API documentation
Diffstat (limited to 'libbe')
| -rw-r--r-- | libbe/bug.py | 4 | ||||
| -rw-r--r-- | libbe/bugdir.py | 2 | ||||
| -rw-r--r-- | libbe/command/assign.py | 2 | ||||
| -rw-r--r-- | libbe/command/serve.py | 3 | ||||
| -rw-r--r-- | libbe/comment.py | 2 |
5 files changed, 5 insertions, 8 deletions
diff --git a/libbe/bug.py b/libbe/bug.py index dd68518..8bf32dd 100644 --- a/libbe/bug.py +++ b/libbe/bug.py @@ -122,9 +122,9 @@ load_status(active_status_def, inactive_status_def) class Bug (settings_object.SavedSettingsObject): """A bug (or issue) is a place to store attributes and attach - :class:`libbe.comment.Comment`\s. In mailing-list terms, a bug is + :class:`~libbe.comment.Comment`\s. In mailing-list terms, a bug is analogous to a thread. Bugs are normally stored in - :class:`libbe.bugdir.BugDir`\s. + :class:`~libbe.bugdir.BugDir`\s. >>> b = Bug() >>> print b.status diff --git a/libbe/bugdir.py b/libbe/bugdir.py index fa8edb9..9328b06 100644 --- a/libbe/bugdir.py +++ b/libbe/bugdir.py @@ -88,7 +88,7 @@ class DiskAccessRequired (Exception): class BugDir (list, settings_object.SavedSettingsObject): - """A BugDir is a container for :class:`libbe.bug.Bug`\s, with some + """A BugDir is a container for :class:`~libbe.bug.Bug`\s, with some additional attributes. See :class:`SimpleBugDir` for some bugdir manipulation exampes. diff --git a/libbe/command/assign.py b/libbe/command/assign.py index 2430d23..6abf05e 100644 --- a/libbe/command/assign.py +++ b/libbe/command/assign.py @@ -24,7 +24,7 @@ import libbe.command.util class Assign (libbe.command.Command): - """Assign an individual or group to fix a bug + u"""Assign an individual or group to fix a bug >>> import sys >>> import libbe.bugdir diff --git a/libbe/command/serve.py b/libbe/command/serve.py index 43e07cc..7a98a47 100644 --- a/libbe/command/serve.py +++ b/libbe/command/serve.py @@ -293,9 +293,6 @@ class AuthenticationApp (WSGI_Object): def authenticate(self, environ): """Handle user-authentication sent in the 'Authorization' header. - Basic HTTP/1.0 Authentication - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - This function implements ``Basic`` authentication as described in HTTP/1.0 specification [1]_ . Do not use this module unless you are using SSL, as it transmits unencrypted passwords. diff --git a/libbe/comment.py b/libbe/comment.py index 003bf71..d8632a4 100644 --- a/libbe/comment.py +++ b/libbe/comment.py @@ -100,7 +100,7 @@ def save_comments(bug): class Comment (Tree, settings_object.SavedSettingsObject): - """Comments are a notes that attach to :class:`libbe.bug.Bug`\s in + """Comments are a notes that attach to :class:`~libbe.bug.Bug`\s in threaded trees. In mailing-list terms, a comment is analogous to a single part of an email. |