Fix differences between String and StringName's documentation #95758
+27
−20
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
added
bug
documentation
cherrypick:4.2
Mickeon
commented
Aug 18, 2024
| @@ -263,12 +263,12 @@ | |||
| print("User {id} is {name}.".format([["id", 42], ["name", "Godot"]])) | |||
| [/codeblock] | |||
| See also the [url=$DOCS_URL/tutorials/scripting/gdscript/gdscript_format_string.html]GDScript format string[/url] tutorial. | |||
| [b]Note:[/b] The replacement of placeholders is not done all at once, instead each placeholder is replaced in the order they are passed, this means that if one of the replacement strings contains a key it will also be replaced. This can be very powerful, but can also cause unexpected results if you are not careful. If you do not need to perform replacement in the replacement strings, make sure your replacements do not contain placeholders to ensure reliable results. | |||
| [b]Note:[/b] Each replacement is done sequentially for each element of [param values], [b]not[/b] all at once. This means that if any element is inserted and it contains another placeholder, it may be changed by the next replacement. While this can be very useful, it often causes unexpected results. If not necessary, make sure [param values]'s elements do not contain placeholders. | |||
There was a problem hiding this comment.
The intent was to make this much clearer without rearranging everything, but I am still not particularly fond of this at all. Makes it looks more complex than it really is.
This comment was marked as resolved.
This comment was marked as resolved.
Mickeon
force-pushed
the
documentation-no-differences-String
branch
from
d55372b to
519351f
Compare
This was referenced Aug 18, 2024
Mickeon
removed
cherrypick:4.2
mhilbrunner
approved these changes
Nov 11, 2024
|
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.
The PR's title is pretty self explanatory. There have been changes done to String, but not applied to StringName. This PR fixes that, and tweaks a few other miscellaneous things on the way.
This is not the only class that suffers from subtle differences. Even one small difference adds a whole new string to translate. In my experience this was seriously irritating to see. Not to mention, the inconsistent information given between two similar classes does add up over time.
To all maintainers, please, pay attention to these kinds of classes before approving and merging.
I am aware it is a burden to maintain, but there's currently no system for shared documentation snippets for classes to share, only ideas.