[tor-commits] [stem/master] Tutorial wording revisions

[atagar at torproject.org]

commit 32244cdc3e8fbfff0cb9ca17f848ce8ede8ade3b
Author: Damian Johnson <atagar at torproject.org>
Date:   Tue Mar 19 08:15:19 2013 -0700

    Tutorial wording revisions
    
    Addressing various suggestions from Sean for improving the tutorials.
---
 docs/tutorials/mirror_mirror_on_the_wall.rst   |    3 +++
 docs/tutorials/the_little_relay_that_could.rst |    2 +-
 docs/tutorials/tortoise_and_the_hare.rst       |    4 +++-
 3 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/docs/tutorials/mirror_mirror_on_the_wall.rst b/docs/tutorials/mirror_mirror_on_the_wall.rst
index 1a7f81d..f1080bd 100644
--- a/docs/tutorials/mirror_mirror_on_the_wall.rst
+++ b/docs/tutorials/mirror_mirror_on_the_wall.rst
@@ -1,6 +1,9 @@
 Mirror Mirror on the Wall
 =========================
 
+The following is an overview of **Tor descriptors**. If you're already familiar
+with what they are and where to get them then you may want to skip to the end.
+
 * :ref:`what-is-a-descriptor`
 * :ref:`where-can-i-get-the-current-descriptors`
 * :ref:`where-can-i-get-past-descriptors`
diff --git a/docs/tutorials/the_little_relay_that_could.rst b/docs/tutorials/the_little_relay_that_could.rst
index 4f22b5b..74fbe46 100644
--- a/docs/tutorials/the_little_relay_that_could.rst
+++ b/docs/tutorials/the_little_relay_that_could.rst
@@ -42,7 +42,7 @@ the following configuration options...
 
 When you change your torrc you'll need to either restart Tor is issue a SIGHUP
 for the new settings to take effect. Now let's write a script that tells us how
-many bytes Tor has sent and received...
+many bytes Tor has sent and received since it started...
 
 ::
 
diff --git a/docs/tutorials/tortoise_and_the_hare.rst b/docs/tutorials/tortoise_and_the_hare.rst
index f575853..4277f7c 100644
--- a/docs/tutorials/tortoise_and_the_hare.rst
+++ b/docs/tutorials/tortoise_and_the_hare.rst
@@ -72,7 +72,9 @@ uploaded.
     bandwidth_rates = [(0, 0)] * GRAPH_WIDTH
 
     # Making a partial that wraps the window and bandwidth_rates with a function
-    # for Tor to call when it gets a BW event.
+    # for Tor to call when it gets a BW event. This causes the 'window' and
+    # 'bandwidth_rates' to be provided as the first two arguments whenever
+    # 'bw_event_handler()' is called.
 
     bw_event_handler = functools.partial(_handle_bandwidth_event, window, bandwidth_rates)