kaslo/synapse
1
0
Fork 0
Code Wiki Activity

deploy: dd5cc37aa4

Browse Source
This commit is contained in:
DMRobertson
2022-04-08 13:36:39 +00:00
parent fb8eea7ced
commit a36082ab7b
4 changed files with 8 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
develop/code_style.html
View File

@@ -163,7 +163,7 @@ as an opinionated code formatter, ensuring all comitted code is
properly formatted.</p>
<p>Have <code>black</code> auto-format your code (it shouldn't change any
functionality) with:</p>
<pre><code class="language-sh">black . --exclude=&quot;\.tox|build|env&quot;
<pre><code class="language-sh">black .
</code></pre>
</li>
<li>
@@ -171,7 +171,7 @@ functionality) with:</p>
<p><code>flake8</code> is a code checking tool. We require code to pass <code>flake8</code>
before being merged into the codebase.</p>
<p>Check all application and test code with:</p>
<pre><code class="language-sh">flake8 synapse tests
<pre><code class="language-sh">flake8 .
</code></pre>
</li>
<li>
@@ -179,9 +179,8 @@ before being merged into the codebase.</p>
<p><code>isort</code> ensures imports are nicely formatted, and can suggest and
auto-fix issues such as double-importing.</p>
<p>Auto-fix imports with:</p>
<pre><code class="language-sh">isort -rc synapse tests
<pre><code class="language-sh">isort .
</code></pre>
<p><code>-rc</code> means to recursively search the given directories.</p>
</li>
</ul>
<p>It's worth noting that modern IDEs and text editors can run these tools