## Summary Comprehensive remediation of 146 documentation files to align with Zed's documentation conventions and brand voice guidelines. ## Changes ### YAML Frontmatter - Added `title` and `description` frontmatter to all docs missing it ### Settings UI Pattern - Updated 48+ files to show Settings Editor before JSON examples - Pattern: `Configure X in Settings ({#kb zed::OpenSettings}), or add to your settings file:` - Added `([how to edit](./configuring-zed.md#settings-files))` links for JSON-only settings ### Brand Voice Fixes - Removed exclamation points (command-palette, key-bindings, repl, privacy-and-security, etc.) - Simplified em dash chains to parentheticals (environment, troubleshooting, agent-panel, etc.) - Fixed marketing language (yarn.md intro, development/linux.md) ### Terminology Alignment - `settings UI` -> `Settings Editor` - `sidebar` -> specific panel names (Project Panel, Collab Panel) - `directory` -> `folder` in non-technical contexts - `workspace` -> `project` in non-LSP contexts - `Command Palette` -> `command palette` (lowercase) ### Callout Standardization - Converted various callout formats to standard `> **Note:**` pattern ## Related Depends on conventions established in #49176. Release Notes: - N/A
Showing the changes to docs/src/languages/python.md (1 of 142 files). Show all
Unified · Split
| @@ -1,3 +1,8 @@ | |||
| 1 | --- | ||
| 2 | title: Python | ||
| 3 | description: "Configure Python language support in Zed, including language servers, formatting, and debugging." | ||
| 4 | --- | ||
| 5 | |||
| 1 | # How to Set Up Python in Zed | 6 | # How to Set Up Python in Zed |
| 2 | 7 | ||
| 3 | Python support is available natively in Zed. | 8 | Python support is available natively in Zed. |
| @@ -75,7 +80,9 @@ Other built-in language servers are: · 71 unmodified lines | |||
| 75 | - [Pyright](https://github.com/microsoft/pyright)—The basis for basedpyright. | 80 | - [Pyright](https://github.com/microsoft/pyright)—The basis for basedpyright. |
| 76 | - [PyLSP](https://github.com/python-lsp/python-lsp-server)—A plugin-based language server that integrates with tools like `pycodestyle`, `autopep8`, and `yapf`. | 81 | - [PyLSP](https://github.com/python-lsp/python-lsp-server)—A plugin-based language server that integrates with tools like `pycodestyle`, `autopep8`, and `yapf`. |
| 77 | 82 | ||
| 78 | These are disabled by default, but can be enabled in your settings. For example: | 83 | These are disabled by default, but can be enabled in your settings. |
| 84 | |||
| 85 | Configure language servers in Settings ({#kb zed::OpenSettings}) under Languages > Python, or add to your settings file: | ||
| 79 | 86 | ||
| 80 | ```json [settings] | 87 | ```json [settings] |
| 81 | { | 88 | { |
| @@ -116,7 +123,7 @@ Examples of both kinds of configuration are provided below. Refer to the basedpy · 34 unmodified lines | |||
| 116 | 123 | ||
| 117 | Language server settings for basedpyright in Zed can be set in the `lsp` section of your `settings.json`. | 124 | Language server settings for basedpyright in Zed can be set in the `lsp` section of your `settings.json`. |
| 118 | 125 | ||
| 119 | For example, in order to: | 126 | For example, to: |
| 120 | 127 | ||
| 121 | - diagnose all files in the workspace instead of the only open files default | 128 | - diagnose all files in the workspace instead of the only open files default |
| 122 | - disable inlay hints on function arguments | 129 | - disable inlay hints on function arguments |
| @@ -194,7 +201,9 @@ Zed uses [Ruff](https://github.com/astral-sh/ruff) for formatting and linting Py · 71 unmodified lines | |||
| 194 | 201 | ||
| 195 | ### Configuring Formatting | 202 | ### Configuring Formatting |
| 196 | 203 | ||
| 197 | Formatting in Zed follows a two-phase pipeline: first, code actions on format (`code_actions_on_format`) are executed, followed by the configured formatter: | 204 | Formatting in Zed follows a two-phase pipeline: first, code actions on format (`code_actions_on_format`) are executed, followed by the configured formatter. |
| 205 | |||
| 206 | Configure formatting in Settings ({#kb zed::OpenSettings}) under Languages > Python, or add to your settings file: | ||
| 198 | 207 | ||
| 199 | ```json [settings] | 208 | ```json [settings] |
| 200 | { | 209 | { |
| @@ -213,7 +222,9 @@ Formatting in Zed follows a two-phase pipeline: first, code actions on format (` · 12 unmodified lines | |||
| 213 | } | 222 | } |
| 214 | ``` | 223 | ``` |
| 215 | 224 | ||
| 216 | These two phases are independent. For example, if you prefer [Black](https://github.com/psf/black) for code formatting, but want to keep Ruff's import sorting, you only need to change the formatter phase: | 225 | These two phases are independent. For example, if you prefer [Black](https://github.com/psf/black) for code formatting, but want to keep Ruff's import sorting, you only need to change the formatter phase. |
| 226 | |||
| 227 | Configure in Settings ({#kb zed::OpenSettings}) under Languages > Python, or add to your settings file: | ||
| 217 | 228 | ||
| 218 | ```json [settings] | 229 | ```json [settings] |
| 219 | { | 230 | { |
| @@ -237,7 +248,9 @@ These two phases are independent. For example, if you prefer [Black](https://git · 17 unmodified lines | |||
| 237 | 248 | ||
| 238 | To completely switch to another tool and prevent Ruff from modifying your code at all, you must explicitly set `source.organizeImports.ruff` to false in the `code_actions_on_format` section, in addition to changing the formatter. | 249 | To completely switch to another tool and prevent Ruff from modifying your code at all, you must explicitly set `source.organizeImports.ruff` to false in the `code_actions_on_format` section, in addition to changing the formatter. |
| 239 | 250 | ||
| 240 | To prevent any formatting actions when you save, you can disable format-on-save for Python files in your `settings.json`: | 251 | To prevent any formatting actions when you save, you can disable format-on-save for Python files. |
| 252 | |||
| 253 | Configure in Settings ({#kb zed::OpenSettings}) under Languages > Python, or add to your settings file: | ||
| 241 | 254 | ||
| 242 | ```json [settings] | 255 | ```json [settings] |
| 243 | { | 256 | { |