gitpython-developers
diff --git a/‎doc/source/quickstart.rst‎
Lines changed: 84 additions & 82 deletions b/‎doc/source/quickstart.rst‎
Lines changed: 84 additions & 82 deletions
diff --git a/‎test/test_quick_doc.py‎
Lines changed: 7 additions & 5 deletions b/‎test/test_quick_doc.py‎
Lines changed: 7 additions & 5 deletions
@@ -102,117 +102,119 @@ Recurse through the Tree
 Usage
 ****************
 
-* $ git add <filepath>
-
-.. literalinclude:: ../../test/test_quick_doc.py
-    :language: python
-    :dedent: 8
-    :start-after: # [2-test_cloned_repo_object]
-    :end-before: # ![2-test_cloned_repo_object]
-
-Now lets add the updated file to git
-
-.. literalinclude:: ../../test/test_quick_doc.py
-    :language: python
-    :dedent: 8
-    :start-after: # [3-test_cloned_repo_object]
-    :end-before: # ![3-test_cloned_repo_object]
-
-Notice the add method requires a list as a parameter
-
-Warning: If you experience any trouble with this, try to invoke :class:`git <git.cmd.Git>` instead via repo.git.add(path)
-
-* $ git commit -m message
-
-.. literalinclude:: ../../test/test_quick_doc.py
-    :language: python
-    :dedent: 8
-    :start-after: # [4-test_cloned_repo_object]
-    :end-before: # ![4-test_cloned_repo_object]
-
-* $ git log <file>
-
-A list of commits associated with a file
-
-.. literalinclude:: ../../test/test_quick_doc.py
-    :language: python
-    :dedent: 8
-    :start-after: # [5-test_cloned_repo_object]
-    :end-before: # ![5-test_cloned_repo_object]
-
-Notice this returns a generator object
-
-.. literalinclude:: ../../test/test_quick_doc.py
-    :language: python
-    :dedent: 8
-    :start-after: # [6-test_cloned_repo_object]
-    :end-before: # ![6-test_cloned_repo_object]
-
-returns list of :class:`Commit <git.objects.commit.Commit>` objects
-
-Printing text files
-####################
-Lets print the latest version of `<local_dir> dir1/file2.txt`
+Add file to staging area
+########################
 
-.. literalinclude:: ../../test/test_quick_doc.py
-        :language: python
-        :dedent: 8
-        :start-after: # [17-test_cloned_repo_object]
-        :end-before: # ![17-test_cloned_repo_object]
 
-.. literalinclude:: ../../test/test_quick_doc.py
+    .. literalinclude:: ../../test/test_quick_doc.py
         :language: python
         :dedent: 8
-        :start-after: # [18-test_cloned_repo_object]
-        :end-before: # ![18-test_cloned_repo_object]
+        :start-after: # [2-test_cloned_repo_object]
+        :end-before: # ![2-test_cloned_repo_object]
 
-Previous version of `<local_dir>/dir1/file2.txt`
+    Now lets add the updated file to git
 
-.. literalinclude:: ../../test/test_quick_doc.py
+    .. literalinclude:: ../../test/test_quick_doc.py
         :language: python
         :dedent: 8
-        :start-after: # [18.1-test_cloned_repo_object]
-        :end-before: # ![18.1-test_cloned_repo_object]
+        :start-after: # [3-test_cloned_repo_object]
+        :end-before: # ![3-test_cloned_repo_object]
 
-* $ git status
+    Notice the add method requires a list as a parameter
 
-    * Untracked files
+    Warning: If you experience any trouble with this, try to invoke :class:`git <git.cmd.Git>` instead via repo.git.add(path)
 
-    Lets create a new file
+Commit
+######
 
     .. literalinclude:: ../../test/test_quick_doc.py
         :language: python
         :dedent: 8
-        :start-after: # [7-test_cloned_repo_object]
-        :end-before: # ![7-test_cloned_repo_object]
+        :start-after: # [4-test_cloned_repo_object]
+        :end-before: # ![4-test_cloned_repo_object]
+
+List of commits associated with a file
+#######################################
 
     .. literalinclude:: ../../test/test_quick_doc.py
         :language: python
         :dedent: 8
-        :start-after: # [8-test_cloned_repo_object]
-        :end-before: # ![8-test_cloned_repo_object]
+        :start-after: # [5-test_cloned_repo_object]
+        :end-before: # ![5-test_cloned_repo_object]
 
-    * Modified files
+    Notice this returns a generator object
 
     .. literalinclude:: ../../test/test_quick_doc.py
         :language: python
         :dedent: 8
-        :start-after: # [9-test_cloned_repo_object]
-        :end-before: # ![9-test_cloned_repo_object]
+        :start-after: # [6-test_cloned_repo_object]
+        :end-before: # ![6-test_cloned_repo_object]
+
+    returns list of :class:`Commit <git.objects.commit.Commit>` objects
+
+Printing text files
+####################
+Lets print the latest version of `<local_dir> dir1/file2.txt`
 
     .. literalinclude:: ../../test/test_quick_doc.py
-        :language: python
-        :dedent: 8
-        :start-after: # [10-test_cloned_repo_object]
-        :end-before: # ![10-test_cloned_repo_object]
+            :language: python
+            :dedent: 8
+            :start-after: # [17-test_cloned_repo_object]
+            :end-before: # ![17-test_cloned_repo_object]
+
+    .. literalinclude:: ../../test/test_quick_doc.py
+            :language: python
+            :dedent: 8
+            :start-after: # [18-test_cloned_repo_object]
+            :end-before: # ![18-test_cloned_repo_object]
 
-    returns a list of :class:`Diff <git.diff.Diff>` objects
+    Previous version of `<local_dir>/dir1/file2.txt`
 
     .. literalinclude:: ../../test/test_quick_doc.py
-        :language: python
-        :dedent: 8
-        :start-after: # [11-test_cloned_repo_object]
-        :end-before: # ![11-test_cloned_repo_object]
+            :language: python
+            :dedent: 8
+            :start-after: # [18.1-test_cloned_repo_object]
+            :end-before: # ![18.1-test_cloned_repo_object]
+
+Status
+######
+    * Untracked files
+
+        Lets create a new file
+
+        .. literalinclude:: ../../test/test_quick_doc.py
+            :language: python
+            :dedent: 8
+            :start-after: # [7-test_cloned_repo_object]
+            :end-before: # ![7-test_cloned_repo_object]
+
+        .. literalinclude:: ../../test/test_quick_doc.py
+            :language: python
+            :dedent: 8
+            :start-after: # [8-test_cloned_repo_object]
+            :end-before: # ![8-test_cloned_repo_object]
+
+    * Modified files
+
+        .. literalinclude:: ../../test/test_quick_doc.py
+            :language: python
+            :dedent: 8
+            :start-after: # [9-test_cloned_repo_object]
+            :end-before: # ![9-test_cloned_repo_object]
+
+        .. literalinclude:: ../../test/test_quick_doc.py
+            :language: python
+            :dedent: 8
+            :start-after: # [10-test_cloned_repo_object]
+            :end-before: # ![10-test_cloned_repo_object]
+
+        returns a list of :class:`Diff <git.diff.Diff>` objects
+
+        .. literalinclude:: ../../test/test_quick_doc.py
+            :language: python
+            :dedent: 8
+            :start-after: # [11-test_cloned_repo_object]
+            :end-before: # ![11-test_cloned_repo_object]
 
 
 
 
@@ -50,16 +50,20 @@ def test_cloned_repo_object(self, local_dir):
         # ![2-test_cloned_repo_object]
 
         # [3-test_cloned_repo_object]
+        # $ git add <file>
         add_file = [update_file]  # relative path from git root
         repo.index.add(add_file)  # notice the add function requires a list of paths
         # ![3-test_cloned_repo_object]
 
         # code to commit - not sure how to test this
         # [4-test_cloned_repo_object]
+        # $ git commit -m <message>
         repo.index.commit("Update to file2")
         # ![4-test_cloned_repo_object]
 
         # [5-test_cloned_repo_object]
+        # $ git log <file>
+
         # relative path from git root
         repo.iter_commits(all=True, max_count=10, paths=update_file)  # gets the last 10 commits from all branches
 
@@ -78,15 +82,13 @@ def test_cloned_repo_object(self, local_dir):
 
         # Untracked files - create new file
         # [7-test_cloned_repo_object]
-        # We'll create a file5.txt
-
-        with open(f'{local_dir}/file5.txt', 'w') as f:
-            f.write('file5 version 1')
+        f = open(f'{local_dir}/untracked.txt', 'w')  # creates an empty file
+        f.close()
         # ![7-test_cloned_repo_object]
 
         # [8-test_cloned_repo_object]
         repo.untracked_files
-        # Output: ['file5.txt']
+        # Output: ['untracked.txt']
         # ![8-test_cloned_repo_object]
 
         # Modified files