History

Adjust heading levels in docs (#7163)

This PR adjusts the heading levels in the docs, as some of them weren't following the right hierarchy. I also formatted all of the docs with Prettier. Release Notes: - N/A

Marshall Bowers committed 2 years ago

Commit 39200ec1 parent 6e443ac14 files · +144 −137Browse files

Showing the changes to docs/src/languages/python.md (1 of 14 files). Show all

Unified · Split

docs/src/languages/python.md+3−3
@@ -17,8 +17,8 @@ By default, the Pyright language server will look for Python packages in the def · 16 unmodified lines
17 17
18To do this, create a JSON file called `pyrightconfig.json` at the root of your project. This file must include two keys:18To do this, create a JSON file called `pyrightconfig.json` at the root of your project. This file must include two keys:
19 19
20* `venvPath`: a relative path from your project directory to any directory that _contains_ one or more virtual environment directories20- `venvPath`: a relative path from your project directory to any directory that _contains_ one or more virtual environment directories
21* `venv`: the name of a virtual environment directory21- `venv`: the name of a virtual environment directory
22 22
23For example, a common approach is to create a virtual environment directory called `.venv` at the root of your project directory with the following commands:23For example, a common approach is to create a virtual environment directory called `.venv` at the root of your project directory with the following commands:
24 24
@@ -40,7 +40,7 @@ Having done that, you would create a `pyrightconfig.json` with the following con · 15 unmodified lines
40 40
41### Code formatting41### Code formatting
42 42
43The Pyright language server does not provide code formatting. If you want to automatically reformat your Python code when saving, you'll need to specify an _external_code formatter in your settings. See the [configuration](../configuration/configuring-zed.md) documentation for more information.43The Pyright language server does not provide code formatting. If you want to automatically reformat your Python code when saving, you'll need to specify an \_external_code formatter in your settings. See the [configuration](../configuration/configuring-zed.md) documentation for more information.
44 44
45A common tool for formatting python code is [Black](https://black.readthedocs.io/en/stable/). If you have Black installed globally, you can use it to format Python files by adding the following to your `settings.json`:45A common tool for formatting python code is [Black](https://black.readthedocs.io/en/stable/). If you have Black installed globally, you can use it to format Python files by adding the following to your `settings.json`:
46 46

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t