-
-
Notifications
You must be signed in to change notification settings - Fork 21.8k
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
Fix several reported issues in String's documentation #86639
Fix several reported issues in String's documentation #86639
Conversation
b5242b0
to
1348d6d
Compare
c94d9b3
to
691d014
Compare
Sounds good. I changed and removed part of the StringName C# note. I would also say that the PR no longer fully addresses godotengine/godot-docs#8190 because it needs to be stated clearly in the C# differences page, too. |
I think you could make the change to diff --git a/doc/tools/make_rst.py b/doc/tools/make_rst.py
index c3a21f3d7b..df3e928538 100755
--- a/doc/tools/make_rst.py
+++ b/doc/tools/make_rst.py
@@ -105,6 +105,7 @@ EDITOR_CLASSES: List[str] = [
CLASSES_WITH_CSHARP_DIFFERENCES: List[str] = [
"@GlobalScope",
"String",
+ "StringName",
"NodePath",
"Signal",
"Callable",
|
691d014
to
579cbac
Compare
Oh that's neat, I did not realise part of it could have been done in the same repository. Done. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
579cbac
to
46b0f3e
Compare
Addressed the above feedback with an additional note. I didn't want to add the explanation in the same line, to keep the short summary consistent to the other similar methods. |
Thanks! |
Cherry-picked for 4.2.2. |
Cherry-picked for 4.1.4. |
Closes godotengine/godot-docs#8043
Closes godotengine/godot-docs#8044
Closes #86734
Mitigates godotengine/godot-docs#8190
This PR updates the String's class reference slightly.
It formats uppercase and lowercase in their respective String methods and removes a seemingly useless note in
String.capitalize()
and incorporates it with the example code, instead.Finally, for StringName, it adds a note exclusive to C#, because all of the listed methods are not available there. This note is almost word-for-word taken from the bug report godotengine/godot-docs#8190 (@raulsntos)Oh great heavens, news flash. Let's also add some examples for #86734, why not.
Could be easily cherrypicked for prior Godot 4.x versions