[feature] : Improve configuration editor with descriptions

[ns-rse]

Is your feature request related to a problem?

I was pleased to discover that configuration options could be edited on the fly, I guess that is the whole point of having an interactive tool!

Currently the dialog box uses the YAML/dictionary paths for descriptions and doesn't describe what these do.

We found that users needed some guidance as to what the configuration options are and as such the default_config.yaml has verbose one-line comments to help users when editing configuration files.

Describe the solution you would like.

It would be useful if we could parse these out of the YAML and use them as descriptions in the editor dialogue to help guide users and save them the need to view the YAML file or the documentation (although including a link to the documentation would probably be useful to).

Describe the alternatives you have considered.

N/A

Additional context

N/A

[llwiggins]

Hi @ns-rse

I think this is already implemented through information tooltips on the far right of the "Edit Filters and Grains Config" window (see below)

The default window size means you have to scroll to the right or increase the size of the window to see these though!

[ns-rse]

Oh I hadn't realised, its kind of occluded. By default the dialogue box needed scrolling to view those which is why I missed them users (who as naive as me!) might not know this is available.

I think the tooltips as they are would be more useful as descriptors for the parameters on the left as they describe what the value is.

We could then add even more informative tooltips about the impact of changing/what the parameter does to the tooltip to help users understand what is going on. But we should make sure that when the dialogue box opens it shows all content and doesn't need scrolling around to get to the tool tips.