From f96d3b3d2a8e861e2e034b400813ada4aa91f530 Mon Sep 17 00:00:00 2001
From: Madhusudan.C.S
Date: Tue, 7 Sep 2010 16:56:27 +0530
Subject: Added a paragraph about docstrings in the chapter.

---
 tdd/tdd.rst | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

(limited to 'tdd')

diff --git a/tdd/tdd.rst b/tdd/tdd.rst
index c987fb4..a1f97c2 100644
--- a/tdd/tdd.rst
+++ b/tdd/tdd.rst
@@ -525,13 +525,18 @@ code within test_gcd.py module. Our test code looks like this::
   if __name__ == '__main__':
       unittest.main()
 
-Since we don't want to read this file into memory each time we run a
-separate test method, we will read all the data in the file into
-Python lists in the setUp method. The entire data file is kept in a
-list called test_cases which happens to be an attribute of the
-TestGCDFunction class. In the tearDown method of the class we
-will delete this attribute to free up the memory and close the
-opened file.
+Please note that although we highly recommend to write a docstring for
+all the classes, functions and modules we have not done so to keep
+above code compact and we have left it as an exercise for the you to
+add them.
+
+Coming back to tests themselves, since we don't want to read this file
+into memory each time we run a separate test method, we will read all
+the data in the file into Python lists in the setUp method. The entire
+data file is kept in a list called test_cases which happens to be an
+attribute of the TestGCDFunction class. In the tearDown method of the
+class we will delete this attribute to free up the memory and close
+the opened file.
 
 Our actual test code sits in the method which begins with the name
 **test_** as said earlier, the test_gcd method. Note that we import
-- 
cgit