Skip to content

Commit

Permalink
Add grammar style guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael-T-McCann committed Oct 18, 2021
1 parent 07905ca commit 90d7c58
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/source/style.rst
Original file line number Diff line number Diff line change
Expand Up @@ -428,3 +428,21 @@ There are two types of comments: *block* and *inline*. A good rule of thumb to f
i = i & (i-1) == 0: # true if i is 0 or a power of 2 [explains the concept not the code]
If a comment consists of one or more full sentences (as is typically the case for *block* comments), it should start with an upper case letter and end with a period. *Inline* comments often consist of a brief phrase which is not a full sentence, in which case they should have a lower case initial letter and not have a terminating period.

Documentation Pages
-------------------
Documentation that is separate from code (like this page)
should follow the
`IEEE Style Manual
<https://journals.ieeeauthorcenter.ieee.org/your-role-in-article-production/ieee-editorial-style-manual/>`_.
For additional grammar and usage guidance,
refer to `The Chicago Manual of Style <https://www.chicagomanualofstyle.org/>`_.
A few notable guidelines:

* Do not capitalize acronyms or inititalisms when defining them,
e.g., "computer-aided system engineering (CASE),"
"fast Fourier transform (FFT)."

The source code (`.rst` files) for these pages
does not have a line-length guideline,
but line breaks inside text are encouraged.

0 comments on commit 90d7c58

Please sign in to comment.