8000 (Test PR) Investigate CodeQL output (from `copyedit` branch) by EliahKagan · Pull Request #4 · EliahKagan/GitPython · GitHub
[go: up one dir, main page]
Skip to content

(Test PR) Investigate CodeQL output (from copyedit branch) #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 11 commits into from
Closed

(Test PR) Investigate CodeQL output (from copyedit branch) #4

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
9b5531b
Fix typos and further clarify Git.refresh docstring
EliahKagan Feb 24, 2024
c0cd8a8
Clarify comment on shell case in _safer_popen_windows
EliahKagan Feb 24, 2024
afd943a
Tweak message about GIT_PYTHON_REFRESH for 80-column terminals
EliahKagan Feb 24, 2024
e08066c
Revise docstrings in git.__init__ and git.cmd
EliahKagan Feb 24, 2024
8bb882e
Fix concurrency note for stream_object_data
EliahKagan Feb 24, 2024
ba878ef
Reword partial_to_complete_sha_hex note
EliahKagan Feb 24, 2024
3958747
Update CommandError._msg documentation
EliahKagan Feb 24, 2024
f56e1ac
Tweak code formatting in Remote._set_cache_
EliahKagan Feb 24, 2024
fa471fe
Fix up Remote.push docstring
EliahKagan Feb 24, 2024
1cd73ba
Revise docstrings in second-level modules
EliahKagan Feb 25, 2024
29c63ac
Format first Git.execute overload stub like the others
EliahKagan Feb 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Revise docstrings in git.__init__ and git.cmd 
Mainly for formatting.
  • Loading branch information
@EliahKagan
EliahKagan committed Feb 26, 2024
commit e08066cda1f5e76fb7a4ef795bfe435f88584e99
18 changes: 11 additions & 7 deletions git/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,18 +122,22 @@
def refresh(path: Optional[PathLike] = None) -> None:
"""Convenience method for setting the git executable path.

:param path: Optional path to the Git executable. If not absolute, it is resolved
:param path:
Optional path to the Git executable. If not absolute, it is resolved
immediately, relative to the current directory.

:note: The *path* parameter is usually omitted and cannot be used to specify a
custom command whose location is looked up in a path search on each call. See
:note:
The *path* parameter is usually omitted and cannot be used to specify a custom
command whose location is looked up in a path search on each call. See
:meth:`Git.refresh` for details on how to achieve this.

:note: This calls :meth:`Git.refresh` and sets other global configuration according
to the effect of doing so. As such, this function should usually be used instead
of using :meth:`Git.refresh` or :meth:`FetchInfo.refresh` directly.
:note:
This calls :meth:`Git.refresh` and sets other global configuration according to
the effect of doing so. As such, this function should usually be used instead of
using :meth:`Git.refresh` or :meth:`FetchInfo.refresh` directly.

:note: This function is called automatically, with no arguments, at import time.
:note:
This function is called automatically, with no arguments, at import time.
"""
global GIT_OK
GIT_OK = False
Expand Down
Loading
0