diff options
| author | clokep <clokep@users.noreply.github.com> | 2023-01-11 15:22:27 +0000 |
|---|---|---|
| committer | clokep <clokep@users.noreply.github.com> | 2023-01-11 15:22:27 +0000 |
| commit | f1d31fba38ee30bf697fc5e9a6364e1c37251798 (patch) | |
| tree | 6648a4725c9d73df0b0dabc23d7e1ac71b40bdc9 /develop/code_style.html | |
| parent | deploy: 73f097888eedaad05eda6b2453b6558158c0b032 (diff) | |
| download | synapse-f1d31fba38ee30bf697fc5e9a6364e1c37251798.tar.xz | |
deploy: f4d2a734f977c0a88f3a5fcdea38b7f9490481dc
Diffstat (limited to 'develop/code_style.html')
| -rw-r--r-- | develop/code_style.html | 10 |
1 files changed, 3 insertions, 7 deletions
diff --git a/develop/code_style.html b/develop/code_style.html index c352b63481..4f832a17cd 100644 --- a/develop/code_style.html +++ b/develop/code_style.html @@ -158,17 +158,13 @@ errors in code.</p> <li><a href="https://github.com/charliermarsh/ruff">ruff</a>, which can spot common errors; and</li> <li><a href="https://mypy.readthedocs.io/en/stable/">mypy</a>, a type checker.</li> </ul> -<p>Install them with:</p> -<pre><code class="language-sh">pip install -e ".[lint,mypy]" -</code></pre> -<p>The easiest way to run the lints is to invoke the linter script as follows.</p> -<pre><code class="language-sh">scripts-dev/lint.sh -</code></pre> +<p>See <a href="development/contributing_guide.html#run-the-linters">the contributing guide</a> for instructions +on how to install the above tools and run the linters.</p> <p>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 <code>mypy</code> -on save as they take a while and can be very resource intensive.</p> +on save as it takes a while and can be very resource intensive.</p> <h2 id="general-rules"><a class="header" href="#general-rules">General rules</a></h2> <ul> <li><strong>Naming</strong>: |