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

Useful and consistent tool tips #2967

Open
4 tasks
soininen opened this issue Oct 4, 2024 · 0 comments
Open
4 tasks

Useful and consistent tool tips #2967

soininen opened this issue Oct 4, 2024 · 0 comments
Labels
enhancement Enhancement of existing feature good first issue Good for newcomers

Comments

@soininen
Copy link
Contributor

soininen commented Oct 4, 2024

This issue is about tool tips associated with user interface actions such as tool bar buttons, text fields, etc.

Many actions do not have tool tips at all or the tool tip is just the action's name. In some cases (like 'undo') this should suffice but many actions should have a more explanatory tool tips.

Actions where the action's name suffices as tool tip unless the action does something surprising:

  • new
  • open
  • redo
  • save
  • save as
  • undo
  • other actions where the tool tip feels redundant

To make tool tips consistent, we should follow some guidelines

  • The verb should be in simple present: "Show commit viewer", not "Shows commit viewer".
  • Tool tips are usually not full sentences so there is no need to add a dot to the end
  • Keyboards shortcut, if any, should be included in the tool tip by add_keyboard_shortcut_to_tool_tip(). For actions that are in the .ui files, a call to add_keyboard_shortcuts_to_action_tool_tips() in the widget's __init__() will do the job.

Check that tool tips follow the above guidelines and fix odd cases:

  • In Toolbox main window
  • In Toolbox dialogs
  • In Database editor
  • In Spine items
@soininen soininen added the enhancement Enhancement of existing feature label Oct 4, 2024
@jkiviluo jkiviluo added the good first issue Good for newcomers label Oct 7, 2024
@jkiviluo jkiviluo added this to the v0.9.0 milestone Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement of existing feature good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants