mirror of
https://github.com/davidhalter/typeshed.git
synced 2026-01-25 20:36:44 +08:00
Add syntax highlight to all shell code blocks (#9445)
This commit is contained in:
@@ -53,7 +53,7 @@ On Linux and Mac OS, you will be able to run the full test suite on Python 3.8,
|
||||
To install the necessary requirements, run the following commands from a
|
||||
terminal window:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ python3 -m venv .venv
|
||||
$ source .venv/bin/activate
|
||||
(.venv)$ pip install -U pip
|
||||
@@ -73,11 +73,11 @@ WSL, follow the Linux/Mac OS instructions above.
|
||||
If you do not wish to install WSL, run the following commands from a Windows
|
||||
terminal to install all non-pytype requirements:
|
||||
|
||||
```
|
||||
```powershell
|
||||
> python -m venv .venv
|
||||
> ".venv/scripts/activate"
|
||||
> .venv\scripts\activate
|
||||
(.venv) > pip install -U pip
|
||||
(.venv) > pip install -r requirements-tests.txt
|
||||
(.venv) > pip install -r "requirements-tests.txt"
|
||||
```
|
||||
|
||||
## Code formatting
|
||||
@@ -93,10 +93,10 @@ right away and add a commit to your PR.
|
||||
That being said, if you *want* to run the checks locally when you commit,
|
||||
you're free to do so. Either run `pycln`, `black` and `isort` manually...
|
||||
|
||||
```
|
||||
pycln --config=pyproject.toml .
|
||||
isort .
|
||||
black .
|
||||
```bash
|
||||
$ pycln --config=pyproject.toml .
|
||||
$ isort .
|
||||
$ black .
|
||||
```
|
||||
|
||||
...Or install the pre-commit hooks: please refer to the
|
||||
@@ -107,8 +107,8 @@ Our code is also linted using `flake8`, with plugins `flake8-pyi`,
|
||||
flake8 before filing a PR is not required. However, if you wish to run flake8
|
||||
locally, install the test dependencies as outlined above, and then run:
|
||||
|
||||
```
|
||||
flake8 .
|
||||
```bash
|
||||
(.venv3)$ flake8 .
|
||||
```
|
||||
|
||||
## Where to make changes
|
||||
@@ -248,7 +248,7 @@ To get started, fork typeshed, clone your fork, and then
|
||||
You can then install the library with `pip` into the virtualenv and run the script,
|
||||
replacing `libraryname` with the name of the library below:
|
||||
|
||||
```
|
||||
```bash
|
||||
(.venv3)$ pip install libraryname
|
||||
(.venv3)$ python3 scripts/create_baseline_stubs.py libraryname
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user