creating a module comments and samples

Author: AbeTavarez

Automations/linux_and_python/pipes/capitalize.py

@@ -1,9 +1,16 @@
 #!/usr/bin/env python3
 import sys
 
-# loops over each line of file
-# that is pass in  as stdin
+# * We use sys.stdin to read from the standard input
+
+# Loops over each line of file
+# that is pass-in  in the stdin
 for line in sys.stdin:
     # strips the new line character
     # then capitalize eatch sentence
     print(line.strip().capitalize())
+
+
+# * We can now re-direct or pipe the context of a file to our capitalize.py script
+# * Use:  cat haiku.txt | ./capitalize.py
+# * Note you can also use: capitalize.py < haiku.txt

creating_a_module/first_module.py

@@ -1,7 +1,7 @@
 
 import math
 
-# *** Calculate aress *** #
+# *** Calculate areas *** #
 
 # * Triangle area
 

creating_a_module/script.py

@@ -1,5 +1,14 @@
 #!/usr/bin/env python3
+
+# * This will import the file or module 'first_module'
+# * and give it the alias 'fm'
 import first_module as fm
-print("Running script...")
 
-print(fm.triangle(5, 3))
+# * Let's use oue 'first_module now'
+
+# * call the triangle function from the 'fm' module
+triangle_area = fm.triangle(5, 3)
+print(triangle_area)
+
+# * call the rectangle function from the 'fm' module
+print()