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

Reference Guide should link to Users Guide where appropriate. #9363

Open
bryevdv opened this issue Nov 4, 2019 · 6 comments
Open

Reference Guide should link to Users Guide where appropriate. #9363

bryevdv opened this issue Nov 4, 2019 · 6 comments

Comments

@bryevdv
Copy link
Member

bryevdv commented Nov 4, 2019

E.g. the Slope reference guide entry could link to the "Adding Anotations" User Guide section for a more complete discussion.

@santos22
Copy link
Contributor

santos22 commented May 17, 2020

I can look into this. Looks like the labels might be off by one. Should I create an issue? Or I could fix this as part of this issue.

In the source, the following should be .. _userguide_plotting_slope: and not .. _userguide_plotting_spans:.

Slopes
------

|Slope| annotations are lines which may be sloped and extend to the
edge of the plot area.

.. bokeh-plot:: docs/user_guide/examples/plotting_slope.py
    :source-position: above

.. _userguide_plotting_spans:

Source: https://raw.githubusercontent.com/bokeh/bokeh/master/sphinx/source/docs/user_guide/annotations.rst

@santos22
Copy link
Contributor

@bryevdv

@santos22
Copy link
Contributor

Whoops. I wasn't using the label correctly. The previous comment can be ignored.

I will work on linking reference guide entries to the following entries in the user guide:

  • Titles
  • Legends
  • Color Bars
  • Arrows
  • Bands
  • Box Annotations
  • Labels
  • Slopes
  • Spans
  • Whiskers

@bryevdv
Copy link
Member Author

bryevdv commented May 17, 2020

@santos22 FYI generally no need to "ping" people everyone here is a volunteer with their own individual schedules and time commitments. OSS issue/PR cycles will often takes days, sometimes weeks, and occasionally longer. Someone will get to things in due time :)

@bryevdv
Copy link
Member Author

bryevdv commented May 20, 2020

Going to leave this issue open as an "evergreen" GFI for adding more linkages between user guide and ref guide

@Med16-11
Copy link
Contributor

Hello @bryevdv @tcmetzger I am an Outreachy applicant and would like to work on this issue.

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

4 participants