diff options
author | flywind <43030857+xflywind@users.noreply.github.com> | 2021-01-01 11:33:35 -0600 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-01-01 18:33:35 +0100 |
commit | 4a479f4a6eb2f9c5a3665d95fa86d993fdb66281 (patch) | |
tree | edf8631359eda56b1c696eaf7d972efe902413a8 | |
parent | eb25d7dd712bd339f11becbf5499d04930382a30 (diff) | |
download | Nim-4a479f4a6eb2f9c5a3665d95fa86d993fdb66281.tar.gz |
update contributing.rst (#16530)
* update docs * Apply suggestions from code review * Update doc/contributing.rst
-rw-r--r-- | doc/contributing.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/contributing.rst b/doc/contributing.rst index 34c963410..d1837ac14 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -239,7 +239,7 @@ not guaranteed to stay in sync, so ``runnableExamples`` is usually preferred: .. code-block:: nim proc someproc*(): string = - ## Return "something" + ## Returns "something" ## ## .. code-block:: ## echo someproc() # "something" @@ -262,12 +262,12 @@ first appearance of the proc. echo "hello" The preferred documentation style is to begin with a capital letter and use -the imperative (command) form. That is, between: +the third-person singular. That is, between: .. code-block:: nim proc hello*(): string = - ## Return "hello" + ## Returns "hello" result = "hello" or @@ -275,7 +275,7 @@ or .. code-block:: nim proc hello*(): string = - ## says hello + ## say hello result = "hello" the first is preferred. |