diff options
| author | Ben Nathanson <github@bigriver.xyz> | 2020-09-28 17:14:07 -0400 |
|---|---|---|
| committer | Ben Nathanson <github@bigriver.xyz> | 2020-09-28 17:14:07 -0400 |
| commit | d7b88ad4b695f7994f471d2f0b4e493d072d3cc1 (patch) | |
| tree | 78fe7740f55b66ac6d9f36b079cd4c9d96e17103 /doc/source/docs/howto_document.rst | |
| parent | 34d7d395d79f880dc9e156ff83af0cf5844867bf (diff) | |
| download | numpy-d7b88ad4b695f7994f471d2f0b4e493d072d3cc1.tar.gz | |
DOC: Update info on doc style rules
Diffstat (limited to 'doc/source/docs/howto_document.rst')
| -rw-r--r-- | doc/source/docs/howto_document.rst | 32 |
1 files changed, 28 insertions, 4 deletions
diff --git a/doc/source/docs/howto_document.rst b/doc/source/docs/howto_document.rst index 9f9068ab3..7cd97b954 100644 --- a/doc/source/docs/howto_document.rst +++ b/doc/source/docs/howto_document.rst @@ -1,12 +1,36 @@ .. _howto-document: -A Guide to NumPy/SciPy Documentation -==================================== +A Guide to NumPy Documentation +============================== User documentation -******************* -NumPy text documents should follow the `Google developer documentation style guide <https://developers.google.com/style>`_. +****************** +- In general, we follow the + `Google developer documentation style guide <https://developers.google.com/style>`_. + +- NumPy style governs cases where: + + - Google has no guidance, or + - We prefer not to use the Google style + + Our current rules: + + - We pluralize *index* as *indices* rather than + `indexes <https://developers.google.com/style/word-list#letter-i>`_, + following the precedent of :func:`numpy.indices`. + + - For consistency we also pluralize *matrix* as *matrices*. + +- Grammatical issues inadequately addressed by the NumPy or Google rules are + decided by the section on "Grammar and Usage" in the most recent edition of + the `Chicago Manual of Style + <https://en.wikipedia.org/wiki/The_Chicago_Manual_of_Style>`_. + +- We welcome being + `alerted <https://github.com/numpy/numpy/issues>`_ to cases + we should add to the NumPy style rules. + Docstrings ********** |