From: W. Trevor King <wking@tremily.us>
Date: Fri, 26 Oct 2012 12:55:42 +0000 (-0400)
Subject: doc: clean up top level module docstrings
X-Git-Tag: 1.1.0~42
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=5c0102f49c607d026fe3e32438174b8bdb5872d5;p=be.git

doc: clean up top level module docstrings
---

diff --git a/libbe/bug.py b/libbe/bug.py
index c16fedc..66510ba 100644
--- a/libbe/bug.py
+++ b/libbe/bug.py
@@ -21,7 +21,7 @@
 # You should have received a copy of the GNU General Public License along with
 # Bugs Everywhere.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Define the :py:class:`Bug` class for representing bugs.
+"""Define :py:class:`Bug` for representing bugs.
 """
 
 import copy
diff --git a/libbe/bugdir.py b/libbe/bugdir.py
index 5c7211d..40097f7 100644
--- a/libbe/bugdir.py
+++ b/libbe/bugdir.py
@@ -20,7 +20,7 @@
 # You should have received a copy of the GNU General Public License along with
 # Bugs Everywhere.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Define the :py:class:`BugDir` class for storing a collection of bugs.
+"""Define :py:class:`BugDir` for storing a collection of bugs.
 """
 
 import copy
diff --git a/libbe/comment.py b/libbe/comment.py
index 2cbbb2c..a669e4e 100644
--- a/libbe/comment.py
+++ b/libbe/comment.py
@@ -19,7 +19,7 @@
 # You should have received a copy of the GNU General Public License along with
 # Bugs Everywhere.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Define the :py:class:`Comment` class for representing bug comments.
+"""Define :py:class:`Comment` for representing bug comments.
 """
 
 import base64
diff --git a/libbe/diff.py b/libbe/diff.py
index 14f985e..c2f4e68 100644
--- a/libbe/diff.py
+++ b/libbe/diff.py
@@ -18,7 +18,7 @@
 # You should have received a copy of the GNU General Public License along with
 # Bugs Everywhere.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Tools for comparing two :py:class:`libbe.bug.BugDir`\s.
+"""Tools for comparing two :py:class:`~libbe.bugdir.BugDir`\s.
 """
 
 import difflib
diff --git a/libbe/version.py b/libbe/version.py
old mode 100644
new mode 100755
index fb629f0..64a4408
--- a/libbe/version.py
+++ b/libbe/version.py
@@ -18,12 +18,13 @@
 # You should have received a copy of the GNU General Public License along with
 # Bugs Everywhere.  If not, see <http://www.gnu.org/licenses/>.
 
-"""
-Store version info for this BE installation.  By default, use the
-bzr-generated information in _version.py, but allow manual overriding
-by setting _VERSION.  This allows support of both the "I don't want to
-be bothered setting version strings" and the "I want complete control
-over the version strings" workflows.
+"""Store version info for this BE installation.
+
+By default, use the Git-generated information in
+:py:mod:`~libbe._version`, but allow manual overriding by setting
+:py:data:`libbe.version._VERSION`.  This allows support of both the "I
+don't want to be bothered setting version strings" and the "I want
+complete control over the version strings" workflows.
 """
 
 import copy