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

Tooltips for metrics #292

Open
ing200086 opened this issue Jul 8, 2017 · 3 comments
Open

Tooltips for metrics #292

ing200086 opened this issue Jul 8, 2017 · 3 comments

Comments

@ing200086
Copy link

I really like phpmetrics. I have a recommendation for an enhancement about information about the metrics. For each metric in the table, an information icon tooltip which has a short description of the metric and information about poor/average/good/perfect scores.

I know that I can go to the documentation page, but those short tooltips would be a nice touch.

@niconoe-
Copy link
Contributor

Thank you for your feedback :).

Can you give us examples of where in the generated website you want to add some informaion?

BTW, I don't think it should be tooltips: these are not (or hardly) accessible. Perhaps we can just always display the metrics informations...

@ing200086
Copy link
Author

Thanks for responding.

I am really just trying to recommend a way to have the columns for the different report sections. Be more accessible in plain English. What would you think about having a collapsible panel somewhere on each report page which provides a clearer explanation for each number?

Some interesting items for each would be an explanation for each number, function output boundaries, old values & relative % change, recommended methodologies to lower/raise each score.

These are just ideas, not requirements :)

@nickescobedo
Copy link

Started using this recently and came to say this exact thing. Perhaps a ? that someone can hover showing the definition. Not opposed to something else but remembering all the acronyms is very difficult.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants