commit 2a9d3c856c5dfe4310a836318ae45069a64fde3b
Author: Damian Johnson <[email protected]>
Date: Sat Oct 13 19:27:17 2012 -0700
Clarifying what the tutorial's reader provides
Just realized that newcomers wouldn't know that the DescriptorReader
provided
RelayDescriptor instances in the example (and hence where the methods that
we
use come from). Clarifying that detail.
---
docs/index.rst | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/docs/index.rst b/docs/index.rst
index 197977d..05c5296 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -75,7 +75,7 @@ We've already used the control port, so for this example
we'll use the cached fi
Tor has several descriptor types. For bandwidth information we'll go to the
server descriptors, which are located in the **cached-descriptors** file. These
have somewhat infrequently changing information published by the relays
themselves.
-To read this file we'll use the
:class:`~stem.descriptor.reader.DescriptorReader`, a class designed to read
descriptor files.
+To read this file we'll use the
:class:`~stem.descriptor.reader.DescriptorReader`, a class designed to read
descriptor files. The **cached-descriptors** is full of server descriptors, so
the reader will provide us with
:class:`~stem.descriptor.server_descriptor.RelayDescriptor` instances (a
:class:`~stem.descriptor.server_descriptor.ServerDescriptor` subclass for
relays).
::
_______________________________________________
tor-commits mailing list
[email protected]
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits
