This commit is contained in:
clokep 2023-01-11 15:22:27 +00:00
parent a14f0ff191
commit f1d31fba38
4 changed files with 8 additions and 16 deletions

View file

@ -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://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> <li><a href="https://mypy.readthedocs.io/en/stable/">mypy</a>, a type checker.</li>
</ul> </ul>
<p>Install them with:</p> <p>See <a href="development/contributing_guide.html#run-the-linters">the contributing guide</a> for instructions
<pre><code class="language-sh">pip install -e &quot;.[lint,mypy]&quot; on how to install the above tools and run the linters.</p>
</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>It's worth noting that modern IDEs and text editors can run these tools <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 automatically on save. It may be worth looking into whether this
functionality is supported in your editor for a more convenient functionality is supported in your editor for a more convenient
development workflow. It is not, however, recommended to run <code>mypy</code> 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> <h2 id="general-rules"><a class="header" href="#general-rules">General rules</a></h2>
<ul> <ul>
<li><strong>Naming</strong>: <li><strong>Naming</strong>:

View file

@ -15585,17 +15585,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://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> <li><a href="https://mypy.readthedocs.io/en/stable/">mypy</a>, a type checker.</li>
</ul> </ul>
<p>Install them with:</p> <p>See <a href="development/contributing_guide.html#run-the-linters">the contributing guide</a> for instructions
<pre><code class="language-sh">pip install -e &quot;.[lint,mypy]&quot; on how to install the above tools and run the linters.</p>
</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>It's worth noting that modern IDEs and text editors can run these tools <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 automatically on save. It may be worth looking into whether this
functionality is supported in your editor for a more convenient functionality is supported in your editor for a more convenient
development workflow. It is not, however, recommended to run <code>mypy</code> 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> <h2 id="general-rules"><a class="header" href="#general-rules">General rules</a></h2>
<ul> <ul>
<li><strong>Naming</strong>: <li><strong>Naming</strong>:

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long