Skip to content

minor grammar and typo in gdscript_documentation_comments.rst #7252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 1, 2023
Merged

minor grammar and typo in gdscript_documentation_comments.rst #7252

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions tutorials/scripting/gdscript/gdscript_documentation_comments.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
GDScript documentation comments
===============================

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

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

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

Members that are applicable for the documentation:
Members that are applicable for documentation:

- Inner class
- Constant
Expand Down Expand Up @@ -137,7 +137,7 @@ Examples

## Documenting an inner class.
##
## The same rules apply apply here. The documentation must
## The same rules apply here. The documentation must
## immediately precede the class definition.
##
## @tutorial: https://the/tutorial/url.com
Expand Down