Add documentation in summary tables

[maelle]

Maybe a link to docs somewhere?

Or something on hover, but I'd assume it needs more checks of accessibility for screenreader users.

[mpadge]

Image from @maelle to contextualise this:

The "measure" column needs explaining and interpreting

[mpadge]

The solution which will be committed presently comes from this gist - much simpler and more flexible than tippy.

[mpadge]

@maelle That was fun! Thanks - check it out yourself!

Note for posterity in this issue: This ability relies on an internal tooltip_dictionary() function to match variable names to text entries for tooltips. This has to be manually curated whenever the stats section of the report is modified. Currently will only deposit tooltips for variables included in the dictionary, while ignoring all others.

[maelle]

Awesome! Do we have an idea of how usable it is with a screen reader?

[mpadge]

Re-opening as ping to check that - I'll post a link here for you when that's done

[maelle]

Some notes

• I don't see it in qualR: An R package to download Sao Paulo and Rio de Janeiro air pollution data ropensci/software-review#474 (comment) Maybe it only works locally? I suspect GitHub would disable scripts.
• There could be a link on the thing on top of the tooltip. That would work in all contexts.
• If we discover the tooltip isn't great for screenreaders it should be aria-hidden.

[mpadge]

Oh yeah, that's right, GitHub disables all HTML in issues. A note will have to be added