refactoring

szabgab · Mar 16, 2021 · c921300 · c921300
1 parent 3282b0b
commit c921300
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 9 deletions.
diff --git a/python/examples/refactor/bad_variable.py b/python/examples/refactor/bad_variable.py
@@ -0,0 +1,4 @@
+data = ['Mercury', 'Venus', 'Earth', 'Mars', 'Jupiter', 'Saturn']
+for i in data:
+    print(i)
+
diff --git a/python/examples/refactor/good_variable.py b/python/examples/refactor/good_variable.py
@@ -0,0 +1,4 @@
+celestical_objects = ['Mercury', 'Venus', 'Earth', 'Mars', 'Jupiter', 'Saturn']
+for planet in celestical_objects:
+    print(planet)
+
diff --git a/python/python.json b/python/python.json
@@ -109,7 +109,7 @@
         "algorithm.md",
         "scapy.md",
         "turtle.md",
-        "refactor.md",
+        "refactoring.md",
         "other.md"
     ]
 }
diff --git a/python/refactor.md b/python/refactor.md
diff --git a/python/refactoring.md b/python/refactoring.md
@@ -0,0 +1,22 @@
+# Refactor
+{id: refactor}
+
+## Refactoring example - change variable name
+{id: refactoring-change-variable-name}
+
+![](examples/refactor/bad_variable.py)
+
+![](examples/refactor/good_variable.py)
+
+## How to Refactor
+{id: how-to-refactor}
+
+* Write tests that will verify the behaviour (or at least compare the new behavior to the old behavior)
+* Make a small change.
+* Run the tests.
+
+## Exercise: Fix deep indentation
+{id: exercise-fix-deep-indentation}
+
+![](examples/refactor/remove_deep_indentation.py)
+