mirror of
https://github.com/nim-lang/Nim.git
synced 2026-02-13 06:43:52 +00:00
update contributing.rst (#16530)
* update docs * Apply suggestions from code review * Update doc/contributing.rst
This commit is contained in:
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user