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

[doc] Use "param" instead of "code" to refer to parameters #3 #64196

Merged
merged 1 commit into from
Aug 12, 2022

Conversation

asmaloney
Copy link
Contributor

One of several commits to fix all of the class XML docs (see #64134, #64164).

Copy link
Contributor

@YuriSizov YuriSizov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I've decided not to add any changes to the language of the docs, even though some places could really use it. Ultimately it's not in the scope of these PRs, and they are big as is.

But we should consider doing more clean-up passes in the future. One thing that definitely can be improved is parameter naming. We need to move away from concatenated, shortened names (newname, idx => new_name, index), as well as short, abstract, non-descriptive names (to, at). IMO names below 3 characters should not be allowed at all, unless it's something extremely obvious, like X, Y, and Z aspects of a vector.

@YuriSizov YuriSizov merged commit 65a1d86 into godotengine:master Aug 12, 2022
@YuriSizov
Copy link
Contributor

Thanks!

@asmaloney asmaloney deleted the doc-params-3 branch August 12, 2022 12:34
@asmaloney
Copy link
Contributor Author

I agree - I've noticed a lot of this (idx in particular drives me crazy 😆). And some inconsistencies like one function enable_foo taking enable and then its counterpart disable_foo taking disabled. These should be consistent - enable/disable or enabled/disabled.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants