Revise docstrings, comments, and a few messages#1850
Merged
Byron merged 61 commits intogitpython-developers:maingitpython-developers/GitPython:mainfrom Feb 29, 2024
Commits
Commits on Feb 26, 2024
Fix typos and further clarify Git.refresh docstring
Show description for 9b5531bcommitted- committed
Tweak message about GIT_PYTHON_REFRESH for 80-column terminals
Show description for afd943acommittedRevise docstrings in git.__init__ and git.cmd
Show description for e08066ccommitted- committed
Reword partial_to_complete_sha_hex note
Show description for ba878efcommittedUpdate CommandError._msg documentation
Show description for 3958747committedTweak code formatting in Remote._set_cache_
Show description for f56e1accommittedFix up Remote.push docstring
Show description for fa471fecommittedRevise docstrings in second-level modules
Show description for 1cd73bacommittedFormat first Git.execute overload stub like the others
Show description for 29c63accommittedShow full-path refresh() in failure message differently
Show description for cd8a312committedRevise docstrings within git.index
Show description for 8ec7e32committedRewrite post_clear_cache note
Show description for ca2ab61committedFurther revise post_clear_cache docstring
Show description for 37421e1committedCondense output_stream description in Git.execute docstring
Show description for ca32c22committedClarify Submodule.branch_path documentation
Show description for 3813bfbcommitted
Commits on Feb 27, 2024
- committed
Change _write to write in SubmoduleConfigParser docstring
Show description for 115451dcommittedFix IndexObject.abspath docstring formatting
Show description for 5219489committed- committed
Revise docstrings within git.objects
Show description for ae37a4acommittedFix backslash formatting in git.util docstrings
Show description for 37011bfcommittedFurther git.util docstring revisions
Show description for d9fb2f4committed- committed
Fix backslashes in Repo.__init__ docstring
Show description for 4f67369committedFix Repo.iter_commits docstring about return type
Show description for 0c8ca1acommitted
Commits on Feb 28, 2024
- committed
Adjust spacing in colon seach mode NotImplementedError
Show description for c67b2e2committedUpdate git source link in Repo.merge_base comment
Show description for 5ee8744committed- committed
Fix recent inconsistency, using :raise:, not :raises:
Show description for bcc0c27committedFurther revise docstrings in git.objects.submodule.base
Show description for 0231b74committedRevise Repo.archive docstring
Show description for 8344f44committedFix another :raises: to :raise:
Show description for 432ec72committedFully qualify non-builtin exceptions in :raise:
Show description for 5ca5844committed- committed
Further revise docstrings in second-level modules
Show description for cd61eb4committedUndo a couple minor black-incompatible changes
Show description for fc1762bcommitted- committed
- committed
- committed
Fix erroneous reference to DateTime "class"
Show description for 30f7da5committed
Commits on Feb 29, 2024
Improve docstrings about tags
Show description for 6126997committedFix param name in TagRefernece docstring and add info
Show description for 110706ecommittedUndo some expansion of "reference" parameter
Show description for b0e5bffcommitted- committed
- committed
Better explain conditional cleanup in test_base_object
Show description for 608147ecommittedRevise test suite docstrings and comments
Show description for 5cf5b60committedBetter clarify Submodule.branch_path documentation
Show description for 4b04d8acommitted- committed
Fix exception type in require_remote_ref_path docstring
Show description for 679d2e8committed- committed
- committed
- committed
- committed
- committed
Remove note in GitCmdObjectDB docstring
Show description for 63983c2committedSomewhat improve _get_ref_info{,_helper} docstrings
Show description for f43292ecommittedA couple more small docstring refinements
Show description for 37c93decommitted