Skip to content

Commit b2d4a48

Browse files
authored
Merge pull request godotengine#7252 from cammytown/patch-1
minor grammar and typo in gdscript_documentation_comments.rst
2 parents 95eb254 + da69035 commit b2d4a48

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

tutorials/scripting/gdscript/gdscript_documentation_comments.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
GDScript documentation comments
44
===============================
55

6-
In GDScript, comments can be used to document your code and add description to the
6+
In GDScript, comments can be used to document your code and add descriptions to the
77
members of a script. There are two differences between a normal comment and a documentation
88
comment. Firstly, a documentation comment should start with double hash symbols
99
``##``. Secondly, it must immediately precede a script member, or for script descriptions,
@@ -22,8 +22,8 @@ suggested format for script documentation can be divided into three parts.
2222
- Tutorials.
2323

2424
To separate these from each other, the documentation comments use special tags.
25-
The tag must be at the beginning of a line (ignoring preceding white space) and has
26-
the format ``@``, followed by the keyword and finishing with a colon.
25+
The tag must be at the beginning of a line (ignoring preceding white space) and must
26+
have the format ``@``, followed by the keyword, and finishing with a colon.
2727

2828
Tags
2929
~~~~
@@ -69,10 +69,10 @@ The description can have more than one line but every line must start
6969
with the double hash symbol ``##`` to be considered as part of the documentation.
7070
The script documentation will update in the editor help window every time the
7171
script is updated. If any member variable or function name starts with an
72-
underscore it will be treated as private. It will not appear in the documentation and
72+
underscore, it will be treated as private. It will not appear in the documentation and
7373
will be ignored in the help window.
7474

75-
Members that are applicable for the documentation:
75+
Members that are applicable for documentation:
7676

7777
- Inner class
7878
- Constant
@@ -137,7 +137,7 @@ Examples
137137

138138
## Documenting an inner class.
139139
##
140-
## The same rules apply apply here. The documentation must
140+
## The same rules apply here. The documentation must
141141
## immediately precede the class definition.
142142
##
143143
## @tutorial: https://the/tutorial/url.com

0 commit comments

Comments
 (0)