diff options
| author | Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> | 2023-01-11 15:21:12 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-11 15:21:12 +0000 |
| commit | f4d2a734f977c0a88f3a5fcdea38b7f9490481dc (patch) | |
| tree | a4b2389dae2f193fe170bb3e65f0062d7d8ddc0e | |
| parent | Faster remote room joins (worker mode): do not populate external hosts-in-roo... (diff) | |
| download | synapse-f4d2a734f977c0a88f3a5fcdea38b7f9490481dc.tar.xz | |
Remove outdated commands from the code style doc & point to the contributing guide. (#14773)
| -rw-r--r-- | changelog.d/14773.doc | 1 | ||||
| -rw-r--r-- | docs/code_style.md | 15 |
2 files changed, 4 insertions, 12 deletions
diff --git a/changelog.d/14773.doc b/changelog.d/14773.doc new file mode 100644 index 0000000000..0992444be0 --- /dev/null +++ b/changelog.d/14773.doc @@ -0,0 +1 @@ +Remove duplicate commands from the Code Style documentation page; point to the Contributing Guide instead. \ No newline at end of file diff --git a/docs/code_style.md b/docs/code_style.md index 3aa7d0d741..026001b8a3 100644 --- a/docs/code_style.md +++ b/docs/code_style.md @@ -13,23 +13,14 @@ The necessary tools are: - [ruff](https://github.com/charliermarsh/ruff), which can spot common errors; and - [mypy](https://mypy.readthedocs.io/en/stable/), a type checker. -Install them with: - -```sh -pip install -e ".[lint,mypy]" -``` - -The easiest way to run the lints is to invoke the linter script as follows. - -```sh -scripts-dev/lint.sh -``` +See [the contributing guide](development/contributing_guide.md#run-the-linters) for instructions +on how to install the above tools and run the linters. It's worth noting that modern IDEs and text editors can run these tools automatically on save. It may be worth looking into whether this functionality is supported in your editor for a more convenient development workflow. It is not, however, recommended to run `mypy` -on save as they take a while and can be very resource intensive. +on save as it takes a while and can be very resource intensive. ## General rules |