Skip to content
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

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Dec 30, 2023

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

@Mickeon Mickeon requested a review from a team as a code owner December 30, 2023 13:46
@AThousandShips AThousandShips added bug documentation cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release labels Dec 30, 2023
@AThousandShips AThousandShips added this to the 4.3 milestone Dec 30, 2023
@Mickeon Mickeon force-pushed the please-this-took-me-15-minutes-can-we-merge-it-before-2025 branch 2 times, most recently from b5242b0 to 1348d6d Compare January 4, 2024 17:22
@Mickeon Mickeon force-pushed the please-this-took-me-15-minutes-can-we-merge-it-before-2025 branch 2 times, most recently from c94d9b3 to 691d014 Compare January 6, 2024 12:08
@Mickeon
Copy link
Contributor Author

Mickeon commented Jan 6, 2024

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.

@raulsntos
Copy link
Member

I think you could make the change to CLASSES_WITH_CSHARP_DIFFERENCES in this PR:

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",

@Mickeon Mickeon force-pushed the please-this-took-me-15-minutes-can-we-merge-it-before-2025 branch from 691d014 to 579cbac Compare January 6, 2024 15:04
@Mickeon
Copy link
Contributor Author

Mickeon commented Jan 6, 2024

Oh that's neat, I did not realise part of it could have been done in the same repository. Done.

Copy link
Member

@raulsntos raulsntos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@Mickeon Mickeon force-pushed the please-this-took-me-15-minutes-can-we-merge-it-before-2025 branch from 579cbac to 46b0f3e Compare January 10, 2024 11:21
@Mickeon
Copy link
Contributor Author

Mickeon commented Jan 10, 2024

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.

@akien-mga akien-mga merged commit 339a793 into godotengine:master Jan 11, 2024
15 checks passed
@akien-mga
Copy link
Member

Thanks!

@Mickeon Mickeon deleted the please-this-took-me-15-minutes-can-we-merge-it-before-2025 branch January 11, 2024 16:49
@YuriSizov YuriSizov removed the cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release label Jan 24, 2024
@YuriSizov
Copy link
Contributor

Cherry-picked for 4.2.2.

@YuriSizov YuriSizov removed the cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release label Jan 24, 2024
@YuriSizov
Copy link
Contributor

Cherry-picked for 4.1.4.

@YuriSizov YuriSizov changed the title Fixing few reports to String's documentation Fix several reported issues in String's documentation Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants