Cleaned up lesson 10, clarified solution with comments

Charlotte Weaver · Charlotte Weaver · commit 899c7f8bdc13 · 2016-10-14T10:05:54.000-04:00
diff --git a/Lesson10_Regexs/DocClerkSOLUTION.py b/Lesson10_Regexs/DocClerkSOLUTION.py
@@ -1,20 +1,27 @@
 
 import re
 
+# Initialize an empyt paragraph
 paragraph = []
 found_match = False
-# Gold E. Locks (case insensitive, E. or E) Three bears or 3 bears 571 209-4000
+# These are the regexs that we are going to use
+#    Gold E. Locks (case insensitive, E. or E) Three bears or 3 bears 571 209-4000
 patterns = ['gold e\.? locks', 'three bears', '3 bears', '\(?571\)? ?209-?4000']
 with open('evidence.txt', 'r') as fh:
-	for line in fh:
-		if line == '\n':
-			if found_match:
-				print ''.join(paragraph)
-			found_match = False
-			paragraph = []
-
-		for pattern in patterns:
-			if re.search(pattern, line, re.IGNORECASE):
-				found_match = True
-		paragraph.append(line)
+    for line in fh:
+        # If it is the end of a paragraph, 
+        # print the paragraph if we found a match to the regex
+        if line == '\n':
+            if found_match:
+                print ''.join(paragraph)
+            # Reset found_match and paragraph for the next paragraph
+            found_match = False
+            paragraph = []
+        
+        # seach each pattern, and if there is a match, set found_match flag to True
+        for pattern in patterns:
+            if re.search(pattern, line, re.IGNORECASE):
+                found_match = True
+        # Append line to paragraph
+        paragraph.append(line)
 
diff --git a/Lesson10_Regexs/RegularExpressions.ipynb b/Lesson10_Regexs/RegularExpressions.ipynb
@@ -8,11 +8,11 @@
     "\n",
     "Up until now, to search in text we have used string methods find, startswith, endswith, etc. But sometimes you need more power.\n",
     "\n",
-    "Regular expressions (regex) are their own little language that allows you to search through text and find matches with incredibly  complex patterns. \n",
+    "Regular expressions are their own little language that allows you to search through text and find matches with incredibly  complex patterns. \n",
     "\n",
     "A regular expression, also referred to as \"regex\" or \"regexp\", provides a concise and flexible means for matching strings of text, such as particular characters, words, or patterns of characters.\n",
     "\n",
-    "To use regular you must import python's regex library `re`\n",
+    "To use regular you need to import python's regex library `re`\n",
     "https://docs.python.org/2/library/re.html"
    ]
   },
@@ -35,7 +35,7 @@
    },
    "outputs": [],
    "source": [
-    "# To run the examplse we are going to use some of the logs from the \n",
+    "# To run the examples we are going to use some of the logs from the \n",
     "# django project, a web framework for python\n",
     "\n",
     "django_logs = '''commit 722344ee59fb89ea2cd5b906d61b35f76579de4e\n",
@@ -103,7 +103,7 @@
    "source": [
     "## Searching\n",
     "\n",
-    "The most simple thing you can do with regexs in python is search through text to see if there is a match. To do this you use the methods `search` or `match`. `match` only checks if it matches at the beginning of the string and `search` check the whole string.\n",
+    "The simplest thing you can do with regexs in python is search through text to see if there is a match. To do this you use the methods `search` or `match`. `match` only checks if it matches at the beginning of the string and `search` check the whole string.\n",
     "\n",
     "    re.match(pattern, string)  \n",
     "    re.search(pattern, string) "
@@ -162,7 +162,7 @@
    "metadata": {},
    "source": [
     "### TRY IT\n",
-    "search for the word May in the django logs"
+    "Search for the word May in the django logs"
    ]
   },
   {
@@ -389,6 +389,7 @@
     "times = re.findall(time_pattern, django_logs)\n",
     "print times\n",
     "\n",
+    "# Unpacking the tuple in the first line\n",
     "for hours, mins in times:\n",
     "    print \"{} hr {} min\".format(hours, mins)"
    ]
@@ -444,7 +445,7 @@
     "\n",
     "\n",
     "0. Import re\n",
-    "1. Initailize a variable called paragraph to be an empty list and a variable called found_match to false.\n",
+    "1. Initialize a variable called paragraph to be an empty list and a variable called found_match to false.\n",
     "2. Create a list of patterns to match and store in variable called patterns\n",
     "3. Read in test file 'evidence.txt'.\n",
     "4. For line in evidence:\n",
