Docs: Link to GlobalScope string methods from String class ref #98473
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
clayjohn
added
enhancement
documentation
cherrypick:4.2
|
Huh we were actually just talking about this problem in the discord recently |
Mickeon
reviewed
Oct 24, 2024
| @@ -6,6 +6,7 @@ | |||
| <description> | |||
| This is the built-in string Variant type (and the one used by GDScript). Strings may contain any number of Unicode characters, and expose methods useful for manipulating and generating strings. Strings are reference-counted and use a copy-on-write approach (every modification to a string returns a new [String]), so passing them around is cheap in resources. | |||
| Some string methods have corresponding variations. Variations suffixed with [code]n[/code] ([method countn], [method findn], [method replacen], etc.) are [b]case-insensitive[/b] (they make no distinction between uppercase and lowercase letters). Method variations prefixed with [code]r[/code] ([method rfind], [method rsplit], etc.) are reversed, and start from the end of the string, instead of the beginning. | |||
| To convert any Variant to or from a string, see [method @GlobalScope.str], [method @GlobalScope.str_to_var], and [method @GlobalScope.var_to_str]. | |||
There was a problem hiding this comment.
Suggested change
| To convert any Variant to or from a string, see [method @GlobalScope.str], [method @GlobalScope.str_to_var], and [method @GlobalScope.var_to_str]. | |
| To convert any [Variant] to or from a string, see [method @GlobalScope.str], [method @GlobalScope.str_to_var], and [method @GlobalScope.var_to_str]. |
There was a problem hiding this comment.
oop, missed this before merging, my b
There was a problem hiding this comment.
Should I make another PR to fix or does this go in #91521 now?
There was a problem hiding this comment.
I've added it to the tracker since it seems to have been committed like this for a few weeks now. Ideally minor cosmetic mistakes like these shouldn't result in making a new PR fixing just that, but instead done in batches ^^
|
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.
Closes godotengine/godot-docs#10132. If this PR is not approved, the original issue should be closed as not planned.
Adds links to the
@GlobalScopefunctionsstr(),str_to_var(), andvar_to_str()from theStringclass ref. These are the only three@GlobalScopefunctions that are clearly related to strings, rather than just using strings incidentally.These three functions are of interest to users looking at the string documentation. These functions could just as easily have been implemented as static functions
String.from(),String.to_var(), andString.from_var(). So it's due to implementation choices and the class reference's inflexibility that these functions are not currently shown on theStringclass reference. All that, and the fact that at least one user noticed their absence in theStringclass ref, makes them worth linking.I personally don't mind the status quo in which these functions are not linked from the
Stringpage. One way or another, this PR should close the original issue, as either implemented or not planned.