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

Tweak @GlobalScope constants documentation overall #67718

Merged

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Oct 21, 2022

This PR continues where #67208 left off, handling the constants part of the documentation. Pretty big stuff.

This could technically still be a draft, as I would personally prefer to first fill out all of the descriptions, then go into detail and expand over the currently outstandingly dry (I'm looking at you Error constants).
However, there's so many different ways each description could generally be formatted, and despite consulting with the documentation chat (see link for the question), no real consensus was reached, possibly out of uncertainty in the moment.
For now, I have only expanded upon ERR_BUG and ERR_HELP, and each is described in a completely different manner.
I wouldn't want to write the descriptions one way, then go back to readjust them again. I hope that is understandable.

General:

  • Replace most type names with strong references (such as "integer" to "[int]");
  • Made the writing style closer to how the rest of the documentation is formatted.
  • Use uppercase Inspector when referring to the Inspector dock.
  • Describe missing MethodFlags, Variant.Type constants.

Key:

  • Add " key." to the KEY_0 to KEY_9 constants;
  • Reword some MouseButton constants;
    • In a programming context, it's kind of odd hearing about the plural of "mouse". It may be just me, however.

Error:

  • Reword OK constant to flow better, use printerr() over print();
  • Describe where ERR_HELP is used by the engine;
  • Point to the Github Issues Page in ERR_BUG.

PropertyHint:

  • Mention that PROPERTY_HINT_IMAGE_COMPRESS_LOSSY and PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS are unused;
  • Mention that PROPERTY_HINT_PASSWORD allows a placeholder string.
  • Describe PROPERTY_HINT_OBJECT_TOO_BIG, PROPERTY_HINT_MAX.

PropertyUsageFlags:

  • Describe PROPERTY_USAGE_HIGH_END_GFX, PROPERTY_USAGE_ARRAY.

@Mickeon Mickeon requested a review from a team as a code owner October 21, 2022 14:49
@Mickeon Mickeon force-pushed the doc-peeves-the-constant-burden branch 2 times, most recently from 83425fe to e998343 Compare October 21, 2022 15:22
@mhilbrunner mhilbrunner added this to the 4.0 milestone Oct 21, 2022
General:
- Replace most type names with strong references (such as "integer" to "[int]");
- Made the writing style closer to how the rest of the documentation is formatted.
- Use uppercase Inspector when referring to the Inspector dock.
- Describe missing MethodFlags, Variant.Type constants.

Key:
- Add " key." to the `KEY_0` to `KEY_9` constants;
- Reword some MouseButton constants;
	- In a programming context, it's kind of odd hearing about the plural of "mouse".

Error:
- Reword OK constant to flow better, use `printerr()` over `print()`;
- Describe where `ERR_HELP` is used by the engine;
- Point to the Github Issues Page in ERR_BUG.

PropertyHint:
- Mention that PROPERTY_HINT_IMAGE_COMPRESS_LOSSY and PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS are unused;
- Mention that PROPERTY_HINT_PASSWORD allows a placeholder string.
- Describe PROPERTY_HINT_OBJECT_TOO_BIG, PROPERTY_HINT_MAX.

PropertyUsageFlags:
- Describe PROPERTY_USAGE_HIGH_END_GFX, PROPERTY_USAGE_ARRAY.
@Mickeon Mickeon force-pushed the doc-peeves-the-constant-burden branch from e998343 to 965f6e4 Compare October 21, 2022 17:53
@mhilbrunner mhilbrunner merged commit 0b627c4 into godotengine:master Oct 22, 2022
@mhilbrunner
Copy link
Member

Thank you! 🎉

@Mickeon Mickeon deleted the doc-peeves-the-constant-burden branch October 23, 2022 10:22
@Mickeon Mickeon mentioned this pull request Oct 25, 2022
4 tasks
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.

2 participants