Revise docstrings, comments, and a few messages - #1850

Merged

Byron merged 61 commits into

gitpython-developers:mainfrom

EliahKagan:copyedit

Feb 29, 2024

Commits on Feb 26, 2024

Fix typos and further clarify Git.refresh docstring
EliahKagan
committed
9b5531b
Clarify comment on shell case in _safer_popen_windows
EliahKagan
committed
c0cd8a8
Tweak message about GIT_PYTHON_REFRESH for 80-column terminals
EliahKagan
committed
afd943a
Revise docstrings in git.__init__ and git.cmd
EliahKagan
committed
e08066c
Fix concurrency note for stream_object_data
EliahKagan
committed
8bb882e
Reword partial_to_complete_sha_hex note
EliahKagan
committed
ba878ef
Update CommandError._msg documentation
EliahKagan
committed
3958747
Tweak code formatting in Remote._set_cache_
EliahKagan
committed
f56e1ac
Fix up Remote.push docstring
EliahKagan
committed
fa471fe
Revise docstrings in second-level modules
EliahKagan
committed
1cd73ba
Format first Git.execute overload stub like the others
EliahKagan
committed
29c63ac
Show full-path refresh() in failure message differently
EliahKagan
committed
cd8a312
Revise docstrings within git.index
EliahKagan
committed
8ec7e32
Rewrite post_clear_cache note
EliahKagan
committed
ca2ab61
Further revise post_clear_cache docstring
EliahKagan
committed
37421e1
Condense output_stream description in Git.execute docstring
EliahKagan
committed
ca32c22
Clarify Submodule.branch_path documentation
EliahKagan
committed
3813bfb

Commits on Feb 27, 2024

Revise docstrings within git.objects.submodule
EliahKagan
committed
63c62ed
Change _write to write in SubmoduleConfigParser docstring
EliahKagan
committed
115451d
Fix IndexObject.abspath docstring formatting
EliahKagan
committed
5219489
Fix parameter names in TagObject.__init__
EliahKagan
committed
c06dfd9
Revise docstrings within git.objects
EliahKagan
committed
ae37a4a
Fix backslash formatting in git.util docstrings
EliahKagan
committed
37011bf
Further git.util docstring revisions
EliahKagan
committed
d9fb2f4
Revise docstrings within git.refs
EliahKagan
committed
d1d18c2
Fix backslashes in Repo.__init__ docstring
EliahKagan
committed
4f67369
Fix Repo.iter_commits docstring about return type
EliahKagan
committed
0c8ca1a

Commits on Feb 28, 2024

Revise docstrings within git.repo
EliahKagan
committed
b2b6f7c
Adjust spacing in colon seach mode NotImplementedError
EliahKagan
committed
c67b2e2
Update git source link in Repo.merge_base comment
EliahKagan
committed
5ee8744
Update comment about improving expand_path overloads
EliahKagan
committed
c8b6cf0
Fix recent inconsistency, using :raise:, not :raises:
EliahKagan
committed
bcc0c27
Further revise docstrings in git.objects.submodule.base
EliahKagan
committed
0231b74
Revise Repo.archive docstring
EliahKagan
committed
8344f44
Fix another :raises: to :raise:
EliahKagan
committed
432ec72
Fully qualify non-builtin exceptions in :raise:
EliahKagan
committed
5ca5844
Improve Git.execute docstring formatting re: max_chunk_size
EliahKagan
committed
e6768ec
Further revise docstrings in second-level modules
EliahKagan
committed
cd61eb4
Undo a couple minor black-incompatible changes
EliahKagan
committed
fc1762b
Further revise docstrings within git.index
EliahKagan
committed
1b25a13
Further revise docstrings within git.objects.submodule
EliahKagan
committed
08a80aa
Further revise other docstrings within git.objects
EliahKagan
committed
bc48d26
Fix erroneous reference to DateTime "class"
EliahKagan
committed
30f7da5

Commits on Feb 29, 2024

Improve docstrings about tags
EliahKagan
committed
6126997
Fix param name in TagRefernece docstring and add info
EliahKagan
committed
110706e
Undo some expansion of "reference" parameter
EliahKagan
committed
b0e5bff
Add a bit of missing docstring formatting
EliahKagan
committed
a5a1b2c
Further revise docstrings within git.repo
EliahKagan
committed
018ebaf
Better explain conditional cleanup in test_base_object
EliahKagan
committed
608147e
Revise test suite docstrings and comments
EliahKagan
committed
5cf5b60
Better clarify Submodule.branch_path documentation
EliahKagan
committed
4b04d8a
More docstring revisions within git.refs
EliahKagan
committed
254c82a
Fix exception type in require_remote_ref_path docstring
EliahKagan
committed
679d2e8
More docstring revisions in second-level modules and git.__init__
EliahKagan
committed
ee0301a
More docstring revisions within git.repo
EliahKagan
committed
231c3ef
More docstring revisions within git.objects
EliahKagan
committed
e166a0a
More docstring revisions in git.objects.submodule.base
EliahKagan
committed
ffeb7e7
Further refine some docstring revisions
EliahKagan
committed
ec93955
Remove note in GitCmdObjectDB docstring
EliahKagan
committed
63983c2
Somewhat improve _get_ref_info{,_helper} docstrings
EliahKagan
committed
f43292e
A couple more small docstring refinements
EliahKagan
committed
37c93de