You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Add a missing period.
- Indicate sh rather than bash as as the language for syntax
highlighting of shell commands that don't need bash.
I had held off on making that second change in previous revisions
because it would have involved either introducing an inconsistency
or editing the section giving the deprecated signature-checking
instructions. That section was removed in 2671167 (gitpython-developers#1823).
(This also wraps a paragraph where the immediately surrounding text
was wrapped, but that should not affect rendered text, and broader
consistency improvements to Markdown wrapping style are not done.)
@@ -85,15 +85,15 @@ On Windows, `./init-tests-after-clone.sh` can be run in a Git Bash shell.
85
85
86
86
If you are cloning [your own fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks), then replace the above `git clone` command with one that gives the URL of your fork. Or use this [`gh`](https://cli.github.com/) command (assuming you have `gh` and your fork is called `GitPython`):
87
87
88
-
```bash
88
+
```sh
89
89
gh repo clone GitPython
90
90
```
91
91
92
92
Having cloned the repo, create and activate your [virtual environment](https://docs.python.org/3/tutorial/venv.html).
93
93
94
94
Then make an [editable install](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs):
95
95
96
-
```bash
96
+
```sh
97
97
pip install -e ".[test]"
98
98
```
99
99
@@ -105,7 +105,7 @@ In rare cases, you may want to work on GitPython and one or both of its [gitdb](
105
105
106
106
If you want to do that *and* you want the versions in GitPython's git submodules to be used, then pass `-e git/ext/gitdb` and/or `-e git/ext/gitdb/gitdb/ext/smmap` to `pip install`. This can be done in any order, and in separate `pip install` commands or the same one, so long as `-e` appears before *each* path. For example, you can install GitPython, gitdb, and smmap editably in the currently active virtual environment this way:
0 commit comments