Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Made spelling and grammar corrections.

Browse source
This commit is contained in:
telimektar3 2022-02-14 10:13:57 -05:00
parent 1b2c777fc4
commit f0f80a39a0
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CODING_STYLE.md
View file

@ -68,7 +68,7 @@ other text, only code).
### Class docstrings ### Class docstrings
The root class docstring should describe the over-arcing use of the The root class docstring should describe the over-arching use of the
class. It should usually not describe the exact call sequence nor list class. It should usually not describe the exact call sequence nor list
important methods, this tends to be hard to keep updated as the API important methods, this tends to be hard to keep updated as the API
develops. Don't use section markers (`#`, `##` etc). develops. Don't use section markers (`#`, `##` etc).
@ -178,9 +178,9 @@ it easier to read.
### Default Commands ### Default Commands
These represent a special case since Commands in Evennia are using their These represent a special case since Commands in Evennia use their
class docstrings to represent the in-game help entry for that command. class docstrings to represent the in-game help entry for that command.
So for the default look of Command class docstrings see instead For the default look of Command class docstrings see instead
[the default command documentation policy][command-docstrings]. [the default command documentation policy][command-docstrings].
### Automatic docstring templating ### Automatic docstring templating