added new section for diffs and formatting

LeoDaCoda · LeoDaCoda · commit bccf8bc3ee23 · 2023-07-18T00:16:07.000-04:00
diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst
@@ -216,6 +216,30 @@ Status
             :start-after: # [11-test_cloned_repo_object]
             :end-before: # ![11-test_cloned_repo_object]
 
+Diffs
+######
+
+    Compare staging area to head commit
+
+    .. literalinclude:: ../../test/test_quick_doc.py
+            :language: python
+            :dedent: 8
+            :start-after: # [11.1-test_cloned_repo_object]
+            :end-before: # ![11.1-test_cloned_repo_object]
+
+    .. literalinclude:: ../../test/test_quick_doc.py
+                :language: python
+                :dedent: 8
+                :start-after: # [11.2-test_cloned_repo_object]
+                :end-before: # ![11.2-test_cloned_repo_object]
+
+    Compare commit to commit
+
+    .. literalinclude:: ../../test/test_quick_doc.py
+                    :language: python
+                    :dedent: 8
+                    :start-after: # [11.3-test_cloned_repo_object]
+                    :end-before: # ![11.3-test_cloned_repo_object]
 
 
 
diff --git a/test/test_quick_doc.py b/test/test_quick_doc.py
@@ -19,7 +19,7 @@ def test_init_repo_object(self, path_to_dir):
 
         from git import Repo
 
-        repo = Repo.init(path_to_dir)  # git init path/to/dir
+        repo = Repo.init(path_to_dir)
        # ![1-test_init_repo_object]
 
         # [2-test_init_repo_object]
@@ -111,10 +111,43 @@ def test_cloned_repo_object(self, local_dir):
         for d in diffs:
             print(d.a_path)
 
+        # Output
         # Downloads/file3.txt
-        # file4.txt
         # ![11-test_cloned_repo_object]
 
+        # compares staging area to head commit
+        # [11.1-test_cloned_repo_object]
+        diffs = repo.index.diff(repo.head.commit)
+        for d in diffs:
+            print(d.a_path)
+
+        # Output
+
+        # ![11.1-test_cloned_repo_object]
+        # [11.2-test_cloned_repo_object]
+        # lets add untracked.txt
+        repo.index.add(['untracked.txt'])
+        diffs = repo.index.diff(repo.head.commit)
+        for d in diffs:
+            print(d.a_path)
+
+        # Output
+        # untracked.txt
+        # ![11.2-test_cloned_repo_object]
+
+        # Compare commit to commit
+        # [11.3-test_cloned_repo_object]
+        first_commit = [c for c in repo.iter_commits(all=True)][-1]
+        diffs = repo.head.commit.diff(first_commit)
+        for d in diffs:
+            print(d.a_path)
+
+        # Output
+        # dir1/file2.txt
+        # ![11.3-test_cloned_repo_object]
+
+
+
         '''Trees and Blobs'''
 
         # Latest commit tree
@@ -141,7 +174,7 @@ def test_cloned_repo_object(self, local_dir):
         # ![14-test_cloned_repo_object]
 
         # [14.1-test_cloned_repo_object]
-        files_and_dirs = [(entry, entry.name) for entry in tree]
+        files_and_dirs = [(entry, entry.name, entry.type) for entry in tree]
         files_and_dirs
 
         # Output
