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 settings UI #534

Merged
merged 4 commits into from
Jul 9, 2024
Merged

Conversation

mathrick
Copy link
Contributor

@mathrick mathrick commented Jul 8, 2024

Hi, this PR improves the settings dialogue UI, making it significantly more compact, and IMHO, also easier to understand and nicer to look at.

Before:
gdunit-before

After:
gdunit-after

The changes are split into three commits

  1. Remove the value sets of settings from the user-facing help strings. Fixes GD-539: Settings UI help strings should not include internal data #539
  2. Improve the wording of the help strings themselves (more detailed description in the commit message). Fixes GD-540: Improve user-facing help strings in settings UI #540
  3. Improved sizing logic for the grid views displaying the settings, meaning less space is wasted, and huge amounts of unused space don't make the scrollbars huge unnecessarily. Not every tab in the dialogue is currently able to fit in without scrolling on my laptop, but some of them are, and it's generally much nicer. Fixes GD-541: Settings dialogue reserves way more horizontal space than it needs, leading to huge scrollbars #541

I did not make any changes to the settings themselves, everything is as it was before and split across tabs in the same way. I did a full test suite run locally, and everything works aside from the C# tests, which I did not run, as I'm not using Godot Mono.

@MikeSchulze
Copy link
Owner

Hello, thank you for your contribution to this project.

Please be so kind and create another refactoring ticket detailing what you want to achieve and link it to the PR.
It should point out existing problems and possible solutions.
It would be good to have a before/after screenshot in the PR, which can then also be used later for the release notes.
I'll take a look at your changes later today.

@MikeSchulze MikeSchulze added refactoring Mark to refactoring a implementation UI labels Jul 8, 2024
@MikeSchulze MikeSchulze added this to the v4.3.4 milestone Jul 8, 2024
Copy link
Owner

@MikeSchulze MikeSchulze left a comment

Choose a reason for hiding this comment

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

I have checked the changes and looks good.
A have only find minor things, please check my comments.

In addition, the actual dialog size can be shrinking because the properties are now more compact and well sized.
I tried with using reset_size() after component creation but without success, maybe you can fix this too.

Great Job, Thanks

addons/gdUnit4/src/core/GdUnitSettings.gd Outdated Show resolved Hide resolved
addons/gdUnit4/src/core/GdUnitSettings.gd Outdated Show resolved Hide resolved
@mathrick mathrick force-pushed the improve-settings-ui branch from 8eba13b to 95adc9f Compare July 8, 2024 16:41
@mathrick
Copy link
Contributor Author

mathrick commented Jul 8, 2024

Please be so kind and create another refactoring ticket detailing what you want to achieve and link it to the PR. It should point out existing problems and possible solutions. It would be good to have a before/after screenshot in the PR, which can then also be used later for the release notes. I'll take a look at your changes later today.

I made the refactoring tickets, I'll take some screenshots and attach them later today.

In addition, the actual dialog size can be shrinking because the properties are now more compact and well sized. I tried with using reset_size() after component creation but without success, maybe you can fix this too.

Yeah, I ran into that too :(. It seems that no matter what I do, the actual dialogue size won't budge. I don't really understand the way Godot windows work, so I had little luck getting it to do what I want. I tried changing the size in the saved scene, but that value is apparently just completely ignored. The thing that displays on my screen has a completely different shape than what is shown in the 2D editor preview.

mathrick added 2 commits July 8, 2024 09:56
* Improve readability for strings that were unclear / confusing
* Don't add wording which is obvious from the UI itself and identical
  across many settings (such as "If set then ...", "Sets ...",
  "Enable/disable ...")
* Use imperative mood consistently
* Don't add unncessary punctuation
* Optimise strings for compactness where possible
@mathrick mathrick force-pushed the improve-settings-ui branch from 95adc9f to 758b2a6 Compare July 8, 2024 16:58
Repository owner deleted a comment from mathrick Jul 9, 2024
@MikeSchulze
Copy link
Owner

Great job, thanks for contribution to the project.

@MikeSchulze MikeSchulze merged commit d7b8e42 into MikeSchulze:master Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Mark to refactoring a implementation UI
Projects
None yet
2 participants