Tweak @GlobalScope
constants documentation overall
#67718
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
andERR_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:
Key:
KEY_0
toKEY_9
constants;Error:
printerr()
overprint()
;ERR_HELP
is used by the engine;ERR_BUG
.PropertyHint:
PROPERTY_HINT_IMAGE_COMPRESS_LOSSY
andPROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS
are unused;PROPERTY_HINT_PASSWORD
allows a placeholder string.PROPERTY_HINT_OBJECT_TOO_BIG
,PROPERTY_HINT_MAX
.PropertyUsageFlags:
PROPERTY_USAGE_HIGH_END_GFX
,PROPERTY_USAGE_ARRAY
.