docs: constistent docs across repos.

Author: praisetompane

.gitignore

@@ -160,4 +160,6 @@ cython_debug/
 #.idea/
 
 .DS_Store
-.vscode
+.vscode
+
+tools/

.spellcheck_exceptions_dictionary.txt

@@ -7,7 +7,7 @@ DEDENT
 REPL
 BNF
 UTF
-
+MYINC
 
 # authors
 Rossum

README.md

@@ -1,50 +1,55 @@
 # Python
 
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-![build status](https://github.com/praisetompane-programming-languages/python/actions/workflows/python.yaml/badge.svg) <br>
-
-**objective**: An in-depth study of:
-- Python's Interpreter:
-  - This focuses on [CPython](https://github.com/python/cpython).
-- Python's language design, implementation and ecosystem.
-
-## Language Details: 
-  - [language reference](https://docs.python.org/3.11/reference/index.html#reference*index)
-  - [interpreter:](https://github.com/python/cpython)
-    - [Bennett, J. 2019. See CPython run: Getting to know your Python interpreter. North Bay Python](https://www.youtube.com/watch?v=tzYhv61piNY)
-  - [base modules index](https://docs.python.org/3/py-modindex.html)
-  - [standard library reference](https://docs.python.org/3.11/library/index.html)
-  - [packaging and distribution](https://packaging.python.org/en/latest/)
-    - [python packaging authority](https://www.pypa.io/en/latest/)
-    - [glossary](https://packaging.python.org/en/latest/glossary/)
-    - tools:
-      - [pip](https://pypi.org/project/pip/)
-      - [pipenv](https://pipenv.pypa.io/en/latest/)
-    - structuring projects:
-  - [package index](https://pypi.org)
-  - [extending and embedding](https://docs.python.org/3.11/extending/index.html)
-  - [developer contribution guide](https://devguide.python.org/)
-  - memory model:
-    - [computational complexity cost model](https://ocw.mit.edu/courses/6-006-introduction-to-algorithms-fall-2011/pages/readings/python-cost-model/)
-  - history:
-    - [The Story of Python, by Its Creator, Guido van Rossum](https://www.youtube.com/watch?v=J0Aq44Pze-w)
-
-## Testing:
+![build status](https://github.com/praisetompane/python/actions/workflows/python.yaml/badge.svg) <br>
+
+## Objectives
+- An in-depth study of Python's:
+  - Interpreter.
+    - This focuses on [CPython](https://github.com/python/cpython).
+  - Python's design, implementation and ecosystem.
+
+## Language Details
+- [language reference](https://docs.python.org/3.11/reference/index.html#reference*index)
+- [interpreter:](https://github.com/python/cpython)
+  - [Bennett, J. 2019. See CPython run: Getting to know your Python interpreter. North Bay Python](https://www.youtube.com/watch?v=tzYhv61piNY)
+- [base modules index](https://docs.python.org/3/py-modindex.html)
+- [standard library reference](https://docs.python.org/3.11/library/index.html)
+- [packaging and distribution](https://packaging.python.org/en/latest/)
+  - [python packaging authority](https://www.pypa.io/en/latest/)
+  - [glossary](https://packaging.python.org/en/latest/glossary/)
+  - tools:
+    - [pip](https://pypi.org/project/pip/)
+    - [pipenv](https://pipenv.pypa.io/en/latest/)
+  - structuring projects:
+- [package index](https://pypi.org)
+- [extending and embedding](https://docs.python.org/3.11/extending/index.html)
+- [developer contribution guide](https://devguide.python.org/)
+- memory model:
+  - [computational complexity cost model](https://ocw.mit.edu/courses/6-006-introduction-to-algorithms-fall-2011/pages/readings/python-cost-model/)
+- history:
+  - [The Story of Python, by Its Creator, Guido van Rossum](https://www.youtube.com/watch?v=J0Aq44Pze-w)
+
+## Testing
   - [pytest](https://docs.pytest.org/en/latest/index.html#)
 
-## Use Cases:
-  - [Applications for Python](https://www.python.org/about/apps/)
+## Use Cases
+  - [Applications of Python](https://www.python.org/about/apps/)
 
-## Learning Resources:
+## Learning Resources
   - [roadmap](https://roadmap.sh/python)
   - [practice problems](https://www.hackerrank.com/domains/python?filters%5Bstatus%5D%5B%5D=unsolved&badge_type=python)
 
-## Spell Check:
-
+## Spell Check
 ```shell
 pyspelling -c spellcheck.yaml
 ```
 
 # References:
 
+## Legend:
+**Q**: Question for later research
+
+**MYINC**: My Insight/Conjecture [Could Be Unoriginal/False and Likely Is]
+
 **Disclaimer**: This is an ongoing and incomplete project to unpack these concepts and serve as my distributed memory.

standard_library/3_built_in_types/4_iterator_types/0_iterator.py

@@ -0,0 +1,70 @@
+"""
+  def iterator:
+    - formal:
+      - in words: an object that represents a stream of data.
+
+    - properties:
+      - forward and reserve traversal.
+      - can only be traversed once.
+    - plain english: ???
+
+    - intuition: ???
+
+    - properties: ???
+
+    - examples: ???
+
+    - use cases: ???
+        
+    - proof: None. It is a definition.
+      
+  References:
+    PEP 234 – Iterators. https://peps.python.org/pep-0234/
+"""
+
+collection = [i for i in range(5)]
+
+print("Forward Iteration with next(forward_iterator)")
+forward_iterator = iter(collection)
+print(f"Type: {type(forward_iterator)}")
+print(f"Print next element {next(forward_iterator)}")
+print(f"Print next element {next(forward_iterator)}")
+print(f"Print next element {next(forward_iterator)}")
+print(f"Print next element {next(forward_iterator)}")
+print(f"Print next element {next(forward_iterator)}")
+# print(f"Print next element {next(forward_iterator)}")
+print("\n")
+
+print("Forward Iteration with __next__")
+forward_iterator_2 = iter(collection)
+print(f"Print next element {forward_iterator_2.__next__()}")
+print(f"Print next element {forward_iterator_2.__next__()}")
+print(f"Print next element {forward_iterator_2.__next__()}")
+print(f"Print next element {forward_iterator_2.__next__()}")
+print(f"Print next element {forward_iterator_2.__next__()}")
+# print(f"Print next element {forward_iterator)}")
+print("\n")
+
+print("Reverse Iteration")
+reverse_iterator = reversed(collection)
+print(f"Type: {type(forward_iterator)}")
+print(f"Print next element {next(reverse_iterator)}")
+print(f"Print next element {next(reverse_iterator)}")
+print(f"Print next element {next(reverse_iterator)}")
+print(f"Print next element {next(reverse_iterator)}")
+print(f"Print next element {next(reverse_iterator)}")
+# print(f"Print next element {next(reverse_iterator)}")
+print("\n")
+
+# Single Travel Example
+collection = [i for i in range(5)]
+iterator = iter(collection)
+
+print("First pass of the iterator")
+for v in iterator:
+    print(v)
+
+# This next pass will fail, because we have exhausted the iterator's single pass
+print("Second pass of the iterator")
+for v in iterator:
+    print(v)

standard_library/3_built_in_types/4_iterator_types/1_generator.py

@@ -0,0 +1,43 @@
+"""    
+  def generator | generator function: 
+    - formal: 𝑓: any ↦ Generator Iterator
+        - in words: a function that creates and returns a Generator Iterator.
+
+    - plain english: ???
+
+    - intuition: ???
+
+    - properties: ???
+
+    - examples:
+      - useful example: src/applications/math/fibonacci.py
+
+    - use cases: ???
+        
+    - proof: None. It is a definition.
+      
+  References:
+    PEP 255 – Simple Generators. https://www.python.org/dev/peps/pep-0255/#motivation
+
+"""
+
+
+def generate_infinite_numbers():
+    """
+    Generate infinite numbers
+    """
+    number = 0
+    while True:
+        yield number
+        number += 1
+
+
+def generator_expression():
+    sum(i * i for i in range(10))
+
+
+if __name__ == "__main__":
+    for number in generate_infinite_numbers():
+        print(number)
+
+    # print(generator_expression())