Skip to content
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.

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

Always use parentheses when referring to functions in manual #10639

Open
tetrapod00 opened this issue Feb 7, 2025 · 0 comments
Open

Always use parentheses when referring to functions in manual #10639

tetrapod00 opened this issue Feb 7, 2025 · 0 comments
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation content:proofreading Issues and PRs related to proofreading the documentation enhancement

Comments

@tetrapod00
Copy link
Contributor

tetrapod00 commented Feb 7, 2025

Your Godot version:
4.4

Issue description:

In the engine, the class reference includes () in links to methods. In the online class reference, () is not included. In the manual, it's currently mixed whether we include () or not in links and mentions of functions.

Including () is definitely correct to increase clarity, and it's overall currently favored.

We should write down the standard that we include parentheses when referring to functions in the manual. Changing individual instances can't be done all at once, however.

URL to the documentation page (if already existing):
Writing Guidelines > Classes, properties, and methods.

@tetrapod00 tetrapod00 added area:manual Issues and PRs related to the Manual/Tutorials section of the documentation content:proofreading Issues and PRs related to proofreading the documentation enhancement labels Feb 7, 2025
@tetrapod00 tetrapod00 changed the title Always use parentheses when referring to functions. Always use parentheses when referring to functions in manual Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation content:proofreading Issues and PRs related to proofreading the documentation enhancement
Projects
None yet
Development

No branches or pull requests

1 participant