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

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
Next Next commit
Fix typos and further clarify Git.refresh docstring 
This further improves the text previously introduced in gitpython-developers#1829 and
improved in gitpython-developers#1844.
  • Loading branch information
@EliahKagan
EliahKagan committed Feb 26, 2024
commit 9b5531bc0e53e03acff70a8c8250115d2d3c9fa4
8 changes: 4 additions & 4 deletions git/cmd.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,8 +379,8 @@ def refresh(cls, path: Union[None, PathLike] = None) -> bool:
:note: The top-level :func:`git.refresh` should be preferred because it calls
this method and may also update other state accordingly.

:note: There are three different ways to specify what command refreshing causes
to be uses for git:
:note: There are three different ways to specify the command that refreshing
causes to be used for git:

1. Pass no *path* argument and do not set the ``GIT_PYTHON_GIT_EXECUTABLE``
environment variable. The command name ``git`` is used. It is looked up
Expand All @@ -394,9 +394,9 @@ def refresh(cls, path: Union[None, PathLike] = None) -> bool:
in each command run. Setting ``GIT_PYTHON_GIT_EXECUTABLE`` to ``git`` has
the same effect as not setting it.

3. Pass a *path* argument. This path, if not absolute, it immediately
3. Pass a *path* argument. This path, if not absolute, is immediately
resolved, relative to the current directory. This resolution occurs at
the time of the refresh, and when git commands are run, they are run with
the time of the refresh. When git commands are run, they are run using
that previously resolved path. If a *path* argument is passed, the
``GIT_PYTHON_GIT_EXECUTABLE`` environment variable is not consulted.

Expand Down
0