aboutsummaryrefslogtreecommitdiffstats
path: root/pydis_site
diff options
context:
space:
mode:
authorGravatar ks129 <[email protected]>2021-07-09 00:10:24 +0300
committerGravatar GitHub <[email protected]>2021-07-09 00:10:24 +0300
commit0f60abe2305047bcf6d11a9be7f458c03b74cf22 (patch)
tree8427cd022aefde63a965e2896cad663901ad1cab /pydis_site
parentAdd missing colon (diff)
Change wording in The Code Style Guide
Co-authored-by: Numerlor <[email protected]>
Diffstat (limited to 'pydis_site')
-rw-r--r--pydis_site/templates/events/pages/code-jams/the-code-style-guide.html6
1 files changed, 3 insertions, 3 deletions
diff --git a/pydis_site/templates/events/pages/code-jams/the-code-style-guide.html b/pydis_site/templates/events/pages/code-jams/the-code-style-guide.html
index 5e4a957e..a26a973c 100644
--- a/pydis_site/templates/events/pages/code-jams/the-code-style-guide.html
+++ b/pydis_site/templates/events/pages/code-jams/the-code-style-guide.html
@@ -242,9 +242,9 @@
</li>
<li>
<b>Inline comments:</b> You should prefer block comments over inline comments and use inline comments only where it is really necessary.
- Never use inline comments to explain obvious things what line do. If you want to use an inline comment on a variable, think first,
+ Never use inline comments to explain obvious things like what a line does. If you want to use an inline comment on a variable, think first,
maybe you can use a better variable name instead. After code and before the start of inline comments should be at least two spaces.
- Just like block comments, inline comments also have to start with <code>#</code> what should be followed by a single space.
+ Just like block comments, inline comments also have to start with <code>#</code> followed by a single space.
<pre>
<code class="language-python">
# Do not use inline comments to explain things
@@ -267,7 +267,7 @@
Docstrings should start and end with three quotes ("""). There are two types of docstrings: one-line docstrings and multiline docstrings.
One-line docstrings have to start and end in the same line, while multiline docstrings start and end in different lines.
Multiline docstring has two parts: summary line and a longer description, which are separated by one empty line.
- The multiline sentence starting and ending quotes should be at different lines than the content.
+ The multiline sentence start and end quotes should be at different lines than the content.
<pre>
<code class="language-python">
# This is a one-line docstring.