commit 1ee755feb205c478fb5d5d63777318f85f6279ab Author: Damian Johnson <atagar@torproject.org> Date: Sun May 17 12:49:20 2015 -0700 Link to Jordan Wright's consensus chart from our API docs Jordan wrote a great article describing how the consensus is made, and a chard breaking down its sections. This is a perfect fit for our consensus API docs to help it easier to understand. --- stem/descriptor/networkstatus.py | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/stem/descriptor/networkstatus.py b/stem/descriptor/networkstatus.py index a162e2e..f82e9e8 100644 --- a/stem/descriptor/networkstatus.py +++ b/stem/descriptor/networkstatus.py @@ -3,12 +3,13 @@ """ Parsing for Tor network status documents. This supports both the v2 and v3 -dir-spec. Documents can be obtained from a few sources... +`dir-spec <https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt>`_. +Documents can be obtained from a few sources... * The 'cached-consensus' file in Tor's data directory. -* Archived descriptors provided by CollecTor - (https://collector.torproject.org/). +* Archived descriptors provided by `CollecTor + <https://collector.torproject.org/>`_. * Directory authorities and mirrors via their DirPort. @@ -19,6 +20,10 @@ dir-spec. Documents can be obtained from a few sources... * list of :class:`stem.descriptor.router_status_entry.RouterStatusEntry` * document footer +**For a great graphical overview see** `Jordan Wright's chart describing the +anatomy of the consensus +<https://jordan-wright.github.io/images/blog/how_tor_works/consensus.png>`_. + Of these, the router status entry section can be quite large (on the order of hundreds of kilobytes). As such we provide a couple of methods for reading network status documents through :func:`~stem.descriptor.__init__.parse_file`.