Skip to content

Commit e56b3fb

Browse files
committed
Small tweaks to both files
1 parent c1f9520 commit e56b3fb

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

doc/devel/style_guide.rst

+24
Original file line numberDiff line numberDiff line change
@@ -35,23 +35,42 @@ an action.
3535
+------------------------------------+------------------------------------+
3636
| Correct | Incorrect |
3737
+------------------------------------+------------------------------------+
38+
| | |
39+
+------------------------------------+------------------------------------+
3840

3941
Tense
4042
^^^^^
4143
Use present simple tense for explanations. Avoid future tense and other modal
4244
or auxiliary verbs when possible.
4345

46+
+------------------------------------+------------------------------------+
47+
| Correct | Incorrect |
48+
+------------------------------------+------------------------------------+
49+
| | |
50+
+------------------------------------+------------------------------------+
51+
4452
Voice
4553
^^^^^
4654
Write in active sentences. Passive voice is best for situations or condtions
4755
for warning prompts.
4856

57+
+------------------------------------+------------------------------------+
58+
| Correct | Incorrect |
59+
+------------------------------------+------------------------------------+
60+
| | |
61+
+------------------------------------+------------------------------------+
62+
4963
Sentence structure
5064
^^^^^^^^^^^^^^^^^^
5165
Write wih short sentences using Subject-Verb-Object order regularly. Limit
5266
how frequently coordinating conjunctions appear in sentences. Avoid pronoun
5367
referenes and subordinating conjunctive prhases.
5468

69+
+------------------------------------+------------------------------------+
70+
| Correct | Incorrect |
71+
+------------------------------------+------------------------------------+
72+
| | |
73+
+------------------------------------+------------------------------------+
5574

5675
Formatting
5776
==========
@@ -64,6 +83,11 @@ Lists
6483
Bulleted lists are for items that do not require sequencing.
6584
Numbered Lists are exclusively for performing actions in specific order.
6685

86+
+------------------------------------+------------------------------------+
87+
| Correct | Incorrect |
88+
+------------------------------------+------------------------------------+
89+
| | |
90+
+------------------------------------+------------------------------------+
6791

6892
Additional Resources
6993
====================

tutorials/introductory/getting_started.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -668,7 +668,7 @@ def autopct_format(percent, group):
668668
#
669669
# In the unpacking process, numerous Axes can also be assigned to the single
670670
# variable. To reference a specific Axes, you can index the location of the
671-
# respective Axes as a matrix through the single variable.
671+
# respective Axes as a matrix through the single variable as well.
672672
#
673673
# .. note::
674674
#

0 commit comments

Comments
 (0)