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

Add tooltip with the meaning of each plot section #1851

Merged
merged 8 commits into from
Jun 7, 2022
Merged

Conversation

sroy3
Copy link
Contributor

@sroy3 sroy3 commented Jun 7, 2022

For #1635

Screen.Recording.2022-06-07.at.10.35.38.AM.mov

@sroy3 sroy3 added the product PR that affects product label Jun 7, 2022
@sroy3 sroy3 self-assigned this Jun 7, 2022
@sroy3 sroy3 marked this pull request as ready for review June 7, 2022 14:58
@maxagin
Copy link
Contributor

maxagin commented Jun 7, 2022

Very nice @sroy3! Minor: the icon sims a bit off - not centred vertically

@sroy3
Copy link
Contributor Author

sroy3 commented Jun 7, 2022

Very nice @sroy3! Minor: the icon sims a bit off - not centred vertically

You're right. I added a wrapper to make the tooltip work and it skewed the vertical alignment. I fixed it now:
Screen Shot 2022-06-07 at 11 48 46 AM

@sroy3 sroy3 enabled auto-merge (squash) June 7, 2022 22:24
Copy link
Member

@shcheklein shcheklein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How hard it would be to support a link in those descriptions?

@sroy3
Copy link
Contributor Author

sroy3 commented Jun 7, 2022

How hard it would be to support a link in those descriptions?

It's possible, but I'd have to tweak the behaviour of the tooltip a bit so it doesn't close automatically on mouse leave (it's something that's possible with the visible prop of Tooltips with some kind of delay. In other words, Tippy allows us to override default behaviour, but behaviour will have been overridden and not be like other tooltips.)

@codeclimate
Copy link

codeclimate bot commented Jun 7, 2022

Code Climate has analyzed commit 090894b and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (85% is the threshold).

This pull request will bring the total coverage in the repository to 96.8% (0.0% change).

View more on Code Climate.

@sroy3 sroy3 merged commit b5957ee into main Jun 7, 2022
@sroy3 sroy3 deleted the plot-section-meaning branch June 7, 2022 22:44
Comment on lines +40 to +41
[Section.TEMPLATE_PLOTS]:
'JSON, YAML, CSV or TSV files visualized using Vega pre-defined or custom Vega-Lite templates.'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are users expected to know what Vega is?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, if we have time it's better to review and change this text.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And other plot section descriptions, I've done this in the walkthrough.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Successfully merging this pull request may close these issues.

6 participants