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

Clarify docs for HoverTool #6079

Closed
timsnyder opened this Issue Mar 28, 2017 · 2 comments

Comments

Projects
None yet
2 participants
@timsnyder
Contributor

timsnyder commented Mar 28, 2017

I recently read http://bokeh.pydata.org/en/0.12.4/docs/user_guide/tools.html#hovertool looking for the hline or vline behavior. I was thrown off by the first sentence:

The hover tool pops up a tooltip div whenever the cursor is over a glyph.

Reading down the page further to http://bokeh.pydata.org/en/0.12.4/docs/user_guide/tools.html#hover-tool my confusion was reinforced by:

The hover tool displays informational tooltips whenever the cursor is directly over a glyph.

The words "cursor is directly over" led me to believe that I wasn't remembering things correctly. So, I bugged Brian in the gitter:
image

A little tweaking of the HoverTool user-guide text would have kept me reading and eventually gotten me into the refguide where I would have seen hline and vline.

The limitations of hline and vline should be documented in the refguide as well.

Items:

  • make link into refguide more prominently featured. This may be as simple as having 'Reference' included in the link text. When I saw the 'HoverTool' link, I didn't bother to click it because I thought it might just be a self reference to the user-guide.
  • allude to the possibility of hline and vline in user-guide without being a full repeat of all the detial in the refguide
  • clarify limitations of hline and vline in the refguide
  • document the use of '~' in TOOLTIPS as in hover_span.py example. It seems needed for spanning hover modes.
  • update the 'Warning' block in HoverTool Reference to accurately reflect the glifs that are supported.
@timsnyder

This comment has been minimized.

Contributor

timsnyder commented Mar 28, 2017

I'm planning to submit a PR for this before the 0.12.5 release. Feel free to assign this to me.

@bryevdv

This comment has been minimized.

Member

bryevdv commented Apr 25, 2017

@timsnyder @mattpap What does "$~x" do? I can't find anything in the BokehJS code that would explain it or what it does. Is it specific to bokeh.charts somehow? FYI I am going to update the docs along with #6183 and close this issue along with it.

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