[tor-commits] [bridgedb/master] Update bridgedb.parse package docstring.

isis at torproject.org isis at torproject.org
Fri May 16 18:52:51 UTC 2014


commit 6cb45e1cf623fe942c7e9a018192132909eba386
Author: Isis Lovecruft <isis at torproject.org>
Date:   Tue Apr 22 23:13:29 2014 +0000

    Update bridgedb.parse package docstring.
---
 lib/bridgedb/parse/__init__.py |   21 +++++----------------
 1 file changed, 5 insertions(+), 16 deletions(-)

diff --git a/lib/bridgedb/parse/__init__.py b/lib/bridgedb/parse/__init__.py
index 0618dae..90698ed 100644
--- a/lib/bridgedb/parse/__init__.py
+++ b/lib/bridgedb/parse/__init__.py
@@ -9,22 +9,11 @@
 #             (c) 2007-2013, all entities within the AUTHORS file
 # :license: 3-clause BSD, see included LICENSE for information
 
-"""Modules for parsing data.
-
-** Package Overview: **
-
-..
-  parse
-   ||_ parse.addr
-   |   |_ isIPAddress - Check if an arbitrary string is an IP address.
-   |   |_ isIPv4 - Check if an arbitrary string is an IPv4 address.
-   |   |_ isIPv6 - Check if an arbitrary string is an IPv6 address.
-   |   \_ isValidIP - Check that an IP address is valid.
-   |
-   |__ :mod:`bridgedbparse.headers`
-   |__ :mod:`bridgedb.parse.options`
-   \__ :mod:`bridgedb.parse.versions`
-"""
+'''Package containing modules for parsing data.
+
+.. py:module:: bridgedb.parse
+    :synopsis: Package containing modules for parsing data.
+'''
 
 from __future__ import absolute_import
 from __future__ import print_function





More information about the tor-commits mailing list