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

Clarify word separator docs about shortcuts #93665

Merged
merged 1 commit into from
Jul 1, 2024

Conversation

kitbdev
Copy link
Contributor

@kitbdev kitbdev commented Jun 27, 2024

Default and custom word separators affect all word-related actions, not just ctrl+left/right. These can be rebound, so I mention the action instead of the shortcut. I don't mention all of them because it would get too long (backspace word, caret word right, and select word under caret).
Also tweaked the code_complete_enabled description to use the action as well, which can be used regardless of the setting.

@kitbdev kitbdev requested a review from a team as a code owner June 27, 2024 15:36
@AThousandShips AThousandShips added this to the 4.3 milestone Jun 27, 2024
@Mickeon
Copy link
Contributor

Mickeon commented Jun 28, 2024

Conflicted on directly using the action names.
On most users' mind, the shortcut comes first, and the associated action comes second. It does not work like this, sure, but it's much easier to imagine and even experiment with in your text editor of choice.

@kitbdev
Copy link
Contributor Author

kitbdev commented Jun 28, 2024

How about something like:

If [code]false[/code], using word selections or operations such as double-clicking or holding [kbd]Ctrl[/kbd] ([kbd]Cmd[/kbd] on macOS) while pressing [kbd]left[/kbd], [kbd]right[/kbd], [kbd]backspace[/kbd], or [kbd]delete[/kbd], will ...

@Mickeon
Copy link
Contributor

Mickeon commented Jun 28, 2024

I like that more, although it's quite the mouthful. I would recommend rearranging the sentences into something more akin to:

If [code]false[/code], when selecting a word the caret stops moving only if a space or punctuation is detected. Word selection operations include double-clicking or holding [kbd]Ctrl[/kbd] ([kbd]Cmd[/kbd] on macOS) while pressing [kbd]left[/kbd], [kbd]right[/kbd], [kbd]backspace[/kbd], or [kbd]delete[/kbd].

It could also be nice to reword this to explain what true does first, especially if that's the default now.

Note that I'm not always against referring to the actions. I just don't believe it's nice to in the Editor Settings, given there's no direct way to point users to them in the Input Map.

@kitbdev
Copy link
Contributor Author

kitbdev commented Jun 30, 2024

Reworded to show true value first, and hopefully its more clear.
Changed example in custom_word_separators, since # and ! are always treated as separators so there is no point to having them be custom separators (even if default separators are off).
Made sure its clear that the default and custom settings work together additively.
For use_default_word_separators, I tried to find what characters are used when it is false, but I can't easily just put all of them in the description, it contains some characters from the punctuation tables, but not all of them. Instead I marked some common characters that are not included.

Copy link
Contributor

@Mickeon Mickeon left a comment

Choose a reason for hiding this comment

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

Pretty good now, assuming it's accurate.

doc/classes/EditorSettings.xml Outdated Show resolved Hide resolved
@akien-mga akien-mga merged commit 2cb0c20 into godotengine:master Jul 1, 2024
18 checks passed
@akien-mga
Copy link
Member

Thanks!

@kitbdev kitbdev deleted the clarify-word-sep-docs branch July 1, 2024 14:59
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.

4 participants