summaryrefslogtreecommitdiff
path: root/libbe/version.py
diff options
context:
space:
mode:
authorW. Trevor King <wking@tremily.us>2012-10-26 08:55:42 -0400
committerW. Trevor King <wking@tremily.us>2012-10-26 08:55:42 -0400
commit5c0102f49c607d026fe3e32438174b8bdb5872d5 (patch)
tree5edd7cc246a990f0415eec5ef0ea97caa1cb6d70 /libbe/version.py
parent3dc53df836ef169d8c28f98495508bc4531c977f (diff)
doc: clean up top level module docstrings
Diffstat (limited to 'libbe/version.py')
-rwxr-xr-x[-rw-r--r--]libbe/version.py13
1 files changed, 7 insertions, 6 deletions
diff --git a/libbe/version.py b/libbe/version.py
index fb629f0..64a4408 100644..100755
--- 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