Title: Document manual refresh path treatment by EliahKagan · Pull Request #1839 · gitpython-developers/GitPython · GitHub
Open Graph Title: Document manual refresh path treatment by EliahKagan · Pull Request #1839 · gitpython-developers/GitPython
X Title: Document manual refresh path treatment by EliahKagan · Pull Request #1839 · gitpython-developers/GitPython
Description: Fixes #1831 I've proposed some expansions of the git.refresh and git.cmd.Git.refresh docstrings to explain how they set the git command to be used, including how they set paths and how this differs between the different ways they are called. A small amount of information about other aspects is also added. This may reasonable to merge, but it may alternatively need editing. I am unsure if the most important points are clear enough. I also wonder if this can be made shorter. I'd be pleased to make further changes. Some of the information is duplicated across those two refresh functions' docstrings. I did this because, while as argued in #1831 I don't think this is fixing a security bug in GitPython, there are security implications of an application (or other library) using GitPython getting this wrong. Because the text is already longer than I'd like, and because I think it's more important to describe the behavior than to comment on its relevance to security, I have not mentioned security (or safety, etc.) in added text in the docstrings. I am unsure if this is the best choice. It can be contrasted to the more explicitly cautionary tone taken in the USE_SHELL docstring. I put more information in the git.cmd.Git.refresh docstring. leaving the git.refresh docstring less detailed. This is for two reasons. First, it is about the behavior that is part of git.cmd.Git.refresh specifically. Second, when I generate the documentation locally, the API reference doesn't seem to contain anything for the top-level git.refresh function that is what people should actually call (if they call any refresh functions). Putting the details in the git.cmd.Git.refresh docstring should make it available, assuming a documentation build that is overall working for generating the API reference (see #1840). While working on this, I noticed that, in the docstring for USE_SHELL, I had written broken reStructuredText for the unordered list. In my locally generated documentation, the list was run on as a continuous paragraph. The second commit here fixes that.
Open Graph Description: Fixes #1831 I've proposed some expansions of the git.refresh and git.cmd.Git.refresh docstrings to explain how they set the git command to be used, including how they set paths and how this dif...
X Description: Fixes #1831 I've proposed some expansions of the git.refresh and git.cmd.Git.refresh docstrings to explain how they set the git command to be used, including how they set paths and how this...
Opengraph URL: https://github.com/gitpython-developers/GitPython/pull/1839
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/checks(.:format) |
| route-controller | pull_requests |
| route-action | checks |
| fetch-nonce | v2:d1576c00-2733-9fd7-f709-fac608642b47 |
| current-catalog-service-hash | 87dc3bc62d9b466312751bfd5f889726f4f1337bdff4e8be7da7c93d6c00a25a |
| request-id | 9898:4E9DD:1340852:1ABC63F:6968AFE4 |
| html-safe-nonce | 3cab57940e4f9a7450ff73355a10742fd9016546f05adf5dcb1085425dbcffab |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5ODk4OjRFOUREOjEzNDA4NTI6MUFCQzYzRjo2OTY4QUZFNCIsInZpc2l0b3JfaWQiOiIzMzIyMzMyNjA3MzkzODY5Nzk2IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 68996294dad10f23a250e291f022e8d3443f7bdaf7b7c970bc3176117c6cd550 |
| hovercard-subject-tag | pull_request:1740155408 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,checks,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/gitpython-developers/GitPython/pull/1839/checks |
| twitter:image | https://avatars.githubusercontent.com/u/1771172?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/1771172?s=400&v=4 |
| og:image:alt | Fixes #1831 I've proposed some expansions of the git.refresh and git.cmd.Git.refresh docstrings to explain how they set the git command to be used, including how they set paths and how this dif... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | fdc7c66bd36a6c12eb8e771e806db863266e573fc299e77f27505a768d4f8a98 |
| turbo-cache-control | no-preview |
| go-import | github.com/gitpython-developers/GitPython git https://github.com/gitpython-developers/GitPython.git |
| octolytics-dimension-user_id | 503709 |
| octolytics-dimension-user_login | gitpython-developers |
| octolytics-dimension-repository_id | 1126087 |
| octolytics-dimension-repository_nwo | gitpython-developers/GitPython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1126087 |
| octolytics-dimension-repository_network_root_nwo | gitpython-developers/GitPython |
| turbo-body-classes | logged-out env-production page-responsive full-width full-width-p-0 |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 3223a6503d318917691422cdadfbe16cd8fb21e5 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width