Overhaul some "uncommon" wording in class reference #89036
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mickeon
commented
Mar 1, 2024
Comment on lines
+400
to
403
| - 4×8 = rgb(170, 255, 0) - #aaff00 - Not supported on most hardware | ||
| - 8×4 = rgb(255, 170, 0) - #ffaa00 - Not supported on most hardware | ||
| - 8×8 = rgb(255, 255, 0) - #ffff00 - Not supported on most hardware | ||
| [/codeblock] |
Mickeon
force-pushed
the
documentation-uncommon-words-2
branch
from
96eb312
to
5ced935
Compare
doc/classes/CodeEdit.xml
Outdated
| @@ -64,7 +64,7 @@ | |||
| <description> | |||
| Adds a comment delimiter. | |||
| Both the start and end keys must be symbols. Only the start key has to be unique. | |||
| [param line_only] denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. | |||
| [param line_only] defines if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. | |||
There was a problem hiding this comment.
For these I'd either use if ... is true and some apt change, or "controls"
There was a problem hiding this comment.
As of the time of writing I have not a clue on what's the true or false behavior or what they even mean exactly.
There was a problem hiding this comment.
Good point it is a bit cryptic, I'd say to poke who ever added this and have them help
There was a problem hiding this comment.
Figured out, you may take a look again.
Mickeon
force-pushed
the
documentation-uncommon-words-2
branch
2 times, most recently
from
bf6efa0
to
b838a64
Compare
Mickeon
force-pushed
the
documentation-uncommon-words-2
branch
from
b838a64
to
c54e09a
Compare
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Continuation of #87223 (see prior PR for reasoning)
This PR goes around the class reference to attempt to strip out some uncommon words and bring some form of consistency.
Click here to see what I had on Notepad++, if you desire a glimpse of my autism.
whilst -> ??? on the contrary -> conversely, in contrast presented -> ??? deem -> consider denote -> indicate, define in contrast vice versa -> no. nor -> ??? hang -> pause linger -> remain time hungry -> performance-intensive ideally -> ??? etc... -> etc. etc -> etc. bring -> ??? one-click deploy made up of -> divided into, composed by informs inform -> notify, sub-resource -> subresource Moreover -> Furthermore Furthermore -> ??? Additionally -> ??? floating point -> floating-point mitigate -> soften(?) 3x3 -> 3×3 concerns -> reasonsHere's some important ones I think:
To soften the blow and not cause random, unjustified invalidation for the localization teams, this PR also tries to improve upon the descriptions where the "targeted" words appear.