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

Improve how Project & Editor Settings look in built-in docs #89086

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Mar 2, 2024

TL:DR:

Clipboard - March 1, 2024 11_24 PM

Code could be better but it does work!

@Mickeon Mickeon added this to the 4.x milestone Mar 2, 2024
@Mickeon Mickeon force-pushed the documentation-ProjectSettings-members-display-nice branch from fa87835 to fc617eb Compare March 2, 2024 15:38
@Mickeon Mickeon requested a review from a team March 2, 2024 15:48
editor/editor_help.cpp Outdated Show resolved Hide resolved
Comment on lines 2508 to 2514
String setting_name = link_target.trim_prefix("ProjectSettings.").trim_prefix("EditorSettings.");
PackedStringArray setting_sections;
for (const String &section : setting_name.split("/", false)) {
setting_sections.append(EditorPropertyNameProcessor::get_singleton()->process_name(section, EditorPropertyNameProcessor::STYLE_CAPITALIZED));
}
Copy link
Member

Choose a reason for hiding this comment

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

You're opening a can of worms here :)

Two things would need to be taken into account:

  • Localization
  • The configured capitalization style (EditorPropertyNameProcessor::get_settings_style())

CC @timothyqiu

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, using EditorPropertyNameProcessor::get_settings_style() would solve both. It takes localization into account.

@Mickeon Mickeon force-pushed the documentation-ProjectSettings-members-display-nice branch from fc617eb to e9cbafa Compare March 2, 2024 22:14
editor/editor_help.cpp Outdated Show resolved Hide resolved
@Mickeon Mickeon force-pushed the documentation-ProjectSettings-members-display-nice branch from e9cbafa to 8e10245 Compare March 4, 2024 17:12
@Mickeon
Copy link
Contributor Author

Mickeon commented Mar 4, 2024

Should be good now.

Copy link
Member

@akien-mga akien-mga left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@akien-mga akien-mga requested a review from Calinou March 5, 2024 22:04
@akien-mga akien-mga modified the milestones: 4.x, 4.3 Mar 5, 2024
@akien-mga
Copy link
Member

We should probably make a similar change to doc/tools/make_rst.py for the online class reference, to be consistent.

@akien-mga akien-mga merged commit 0fefbe8 into godotengine:master Mar 7, 2024
16 checks passed
@akien-mga
Copy link
Member

Thanks!

@Mickeon Mickeon deleted the documentation-ProjectSettings-members-display-nice branch March 7, 2024 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants