Skip to content

UI: add tooltips. labels and verdicts for rate error, beat error, amplitude and beat rate #13

Description

@xelrix123

Rationale: Timegrapher is a tool that for example I use irregularly (few times a year at a max when I get a new old watch etc.). This means that every time I look at the results, I need to 'refresh' my memory for what were beat errors and rate errors and amplitudes etc. and what do these numbers mean. For people mostly using software timegraphers like tg this is likely typical usage pattern.

While meaning of the measured variables are finely documented online and available via simple search, it would be nice to have these labeled in the UI, complete with tooltips to further explain what the values are about and what are expected ranges. Finally, for rate and beat error it would be nice to have a verdict that would give immediate indication of how good/bad the current results are.

Following is thus proposed:

Add labels and verdicts to UI:

Image

Image above demonstrates how labels could be added for displayed mesurements without altering current layout or dimensions of the UI. Below the measured value, a verdict for 'Rate error' and 'Beat error' is added.

Image

Image above demonstrates a tooltip which when user hovers mouse over the label will give a brief explanation of the measured variable, and if verdicts are provided, then inform user which values translate to which verdicts.

Discussion:

  • is there danger in (a tooltip) highlighting what the ranges should be? Maybe this will lead astray in certain situations? Is it possible to generalize the contents of tooltips in a manner that will be correct and informative in most circumstances?
  • obvious danger with providing verdicts is that they are now taken at face value without any further consideration of the total picture timegrapher is painting.
  • although all information what each field measures is available in both tg docs and generally online, I feel that having a concise summary behind a tooltip really helps getting up to speed with with the sw
  • Should tooltips contain no information / minimal information / lenghtier explanation remains largely matter of taste - however likely users of tg likely are people who already want to dig deeper into what is happening, a bit extra verbosity is warranted here

I will submit shortly a PR that will introduce changes outlined above.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions