doc: clean up top level module docstrings

diff --git a/libbe/bug.py b/libbe/bug.py
index c16fedc4ba2f721d869f4aa11df56a302a86a4ad..66510ba049dcc31f82f71ea44beae8ddf03698d5 100644 (file)
--- 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 5c7211dd5542e53fc8e6e508e672156fc0e0635c..40097f714fd6562b4ec7eb242b7b6f002cfe556f 100644 (file)
--- 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 2cbbb2c68375ddcbae907bff9b34dfca44e96675..a669e4e5012e180f229ca324426dbee53d64994b 100644 (file)
--- 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 14f985e9e70982df8167cf9ceedb2be59229b698..c2f4e685611b10028df4a1a3010646ebc54f49c5 100644 (file)
--- 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 (file)
new mode 100755 (executable)
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