[tor-commits] [stem/master] Commenting tutorial use of curses.wrapper()

[atagar at torproject.org]

commit cbd83abf6e91955d84a87d3dada8548ad13ab99f
Author: Damian Johnson <atagar at torproject.org>
Date:   Tue Mar 19 08:25:06 2013 -0700

    Commenting tutorial use of curses.wrapper()
    
    Suggestion from Lunar for a rough spot in the tutorials.
---
 docs/tutorials/tortoise_and_the_hare.rst |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)

diff --git a/docs/tutorials/tortoise_and_the_hare.rst b/docs/tutorials/tortoise_and_the_hare.rst
index 4277f7c..a791103 100644
--- a/docs/tutorials/tortoise_and_the_hare.rst
+++ b/docs/tutorials/tortoise_and_the_hare.rst
@@ -60,6 +60,10 @@ uploaded.
       controller.authenticate()
 
       try:
+        # This makes curses initialize and call drawBandwidthGraph() with a
+        # reference to the screen, followed by additional arguments (in this
+        # case just the controller).
+
         curses.wrapper(drawBandwidthGraph, controller)
       except KeyboardInterrupt:
         pass  # the user hit ctrl+c