From f0f80a39a0a5c23de7a7e302f6aec0cd09bb37b4 Mon Sep 17 00:00:00 2001 From: telimektar3 <68455040+telimektar3@users.noreply.github.com> Date: Mon, 14 Feb 2022 10:13:57 -0500 Subject: [PATCH] Made spelling and grammar corrections. --- CODING_STYLE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CODING_STYLE.md b/CODING_STYLE.md index 936fd29323..9f6b1c0a8b 100644 --- a/CODING_STYLE.md +++ b/CODING_STYLE.md @@ -68,7 +68,7 @@ other text, only code). ### 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 important methods, this tends to be hard to keep updated as the API develops. Don't use section markers (`#`, `##` etc). @@ -178,9 +178,9 @@ it easier to read. ### 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. -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]. ### Automatic docstring templating