code review prep

Author: colevandersWands

…stepping/.assets/what_is_programming.png .assets/what_is_programming.png2_predictive_stepping/.assets/what_is_programming.png renamed to .assets/what_is_programming.png 2_predictive_stepping/.assets/what_is_programming.png renamed to .assets/what_is_programming.png

@@ -9,7 +9,8 @@ interests, and anything else you'd like to share.
 
 - [ ] You created your Profile README repository using
       [the template `username` repository](https://github.com/MIT-Emerging-Talent/username)
-- [ ] All of the CI checks pass under the Actions tab
+- [ ] Your repository’s name matches your GitHub username.
+- [ ] All of the CI checks pass under the Actions tab. _Or_ you commented the lines that failed CI checks explaining why you broke the rule to get the README you wanted. (eg. “I used HTML to align the image in the center”)
 
 ## Suggested Study
 

1_development_workflows/deliverables.md

@@ -40,7 +40,7 @@ then communicating with everyone involved to deliver quality software within
 your project's constraints. This diagram shows the different channels of
 communication in a simple Python program:
 
-![a program](./.assets/what_is_programming.png)
+![a program](../.assets/what_is_programming.png)
 
 > PS. In the examples and exercises for this chapter you will be both the
 > developer and the user, running the program and interacting with it from

2_predictive_stepping/README.md

@@ -59,7 +59,7 @@ class: center
 
 ## What is Programming?
 
-<img alt="What is programming?" src="./.assets/what_is_programming.png" height="100%"  width="100%">
+<img alt="What is programming?" src="../.assets/what_is_programming.png" height="100%"  width="100%">
 
 ---
 

2_predictive_stepping/lesson_plan.md

@@ -113,14 +113,14 @@ for index in range(2, 500):
 
     assert two_back + one_back == current, f"entry {index} is not correct"
 
-# %% does the function return the same or different arrays?
+# %% does the function return the same or different lists?
 
-array_1 = fibonacci_list(4)
-array_2 = fibonacci_list(6)
+list_1 = fibonacci_list(4)
+list_2 = fibonacci_list(6)
 
-# the function returned two different arrays with the same values
-assert array_1 == array_2, "the arrays store the same values"
-assert array_1 is not array_2, "the variables do not reference the same array"
+# the function returned two different lists with the same values
+assert list_1 == list_2, "the lists store the same values"
+assert list_1 is not list_2, "the variables do not reference the same list"
 ```
 
 </details>

3_documenting_and_testing/behavior_strategy_implementation.md

@@ -143,7 +143,7 @@ simple. For the above example the symptom corresponds to the line where the
 variable went out of bounds or to the `print`s which produced the garbage output.
 The incorrect behavior will correspond to a variable with a bad value. Identify
 the variable(s) with bad values. For this example, suppose that the program
-crashes on line 112 because i is -1 and tries to index an array.
+crashes on line 112 because i is -1 and tries to index an list.
 
 The critical question is: where did i get its value? There are basically three
 ways a variable can get a value: the variable appears on the left hand side of a

4_debugging/philosophy_of_debugging.md

@@ -3,7 +3,7 @@
 This function does not modify the argument list.
 
 Parameters:
-  list[dict[str, str]]: an array of dicts with string keys and string values
+  list[dict[str, str]]: an list of dicts with string keys and string values
   str: the function will remove all dicts that don't have this key
 
 Returns: a list of dicts where each dict contains the given key,

5_tdd_with_llms/examples/filter_and_sort_dictionaries_with_llm/0_docstring.py

@@ -7,7 +7,7 @@ def f(lst, key):
     This function does not modify the argument list.
 
     Parameters:
-      list[dict[str, str]]: an array of dicts with string keys and string values
+      list[dict[str, str]]: an list of dicts with string keys and string values
       str: the function will remove all dicts that don't have this key
 
     Returns: a list of dicts where each dict contains the given key,

5_tdd_with_llms/examples/filter_and_sort_dictionaries_with_llm/1a_generated_tests.py

@@ -7,7 +7,7 @@ def f(lst, key):
     This function does not modify the argument list.
 
     Parameters:
-      list[dict[str, str]]: an array of dicts with string keys and string values
+      list[dict[str, str]]: an list of dicts with string keys and string values
       str: the function will remove all dicts that don't have this key
 
     Returns: a list of dicts where each dict contains the given key,

5_tdd_with_llms/examples/filter_and_sort_dictionaries_with_llm/1b_manual_refactor_tests.py

@@ -7,7 +7,7 @@ def f(lst, key):
     This function does not modify the argument list.
 
     Parameters:
-      list[dict[str, str]]: an array of dicts with string keys and string values
+      list[dict[str, str]]: an list of dicts with string keys and string values
       str: the function will remove all dicts that don't have this key
 
     Returns: a list of dicts where each dict contains the given key,