[tor-commits] [bridgedb/develop] Add module docstring for bridgedb.parse.descriptors.

[isis@xxxxxxxxxxxxxx]

commit 6d7180a895dc205176f34e38a1251f6aae0ef156
Author: Isis Lovecruft <isis@xxxxxxxxxxxxxx>
Date:   Thu Jun 18 04:39:01 2015 +0000

    Add module docstring for bridgedb.parse.descriptors.
---
 lib/bridgedb/parse/descriptors.py |   23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/lib/bridgedb/parse/descriptors.py b/lib/bridgedb/parse/descriptors.py
index 81cba7f..1b0108e 100644
--- a/lib/bridgedb/parse/descriptors.py
+++ b/lib/bridgedb/parse/descriptors.py
@@ -10,6 +10,29 @@
 # :license: see LICENSE for licensing information
 #_____________________________________________________________________________
 
+"""Parsers for Tor Bridge descriptors, including ``bridge-networkstatus``
+documents, ``bridge-server-descriptor``s, and ``bridge-extrainfo``
+descriptors.
+
+.. py:module:: bridgedb.parse.descriptors
+    :synopsis: Parsers for Tor Bridge descriptors.
+
+bridgedb.parse.descriptors
+===========================
+::
+
+ DescriptorWarning - Raised when we parse a very odd descriptor.
+ deduplicate - Deduplicate a container of descriptors, keeping only the newest
+               descriptor for each router.
+ parseNetworkStatusFile - Parse a bridge-networkstatus document generated and
+                          given to us by the BridgeAuthority.
+ parseServerDescriptorsFile - Parse a file containing
+                              bridge-server-descriptors.
+ parseExtraInfoFiles - Parse (multiple) file(s) containing bridge-extrainfo
+                       descriptors.
+..
+"""
+
 from __future__ import print_function
 
 import datetime



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits