Skip to content

Fix #1733: Improve docstrings for Bokeh marker options #1749

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.

Sign up for GitHub

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

Open
rimsha152007-dotcom wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix #1733: Improve docstrings for Bokeh marker options #1749

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions hvplot/plotting/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,14 +405,16 @@ def scatter(self, x=None, y=None, **kwds):
Field name(s) to draw y-positions from. If not specified, all numerical
fields are used.
marker : str, optional
The marker shape. Options depend on the plotting backend:

- Bokeh: 'circle' (default), 'dot', 'cross', 'x', 'square', etc.
See https://docs.bokeh.org/en/latest/docs/examples/basic/scatters/markertypes.html
for the complete list of Bokeh markers.
- Matplotlib: 's' (square), 'x' (cross), '+', 'o' (circle), etc.
See https://matplotlib.org/stable/api/markers_api.html
for the complete list of Matplotlib markers.
The marker shape. Options depend on the plotting backend:

- Bokeh: Supports standard Bokeh marker names (e.g., 'circle', 'square', 'triangle',
'cross', 'diamond', 'asterisk') as well as Matplotlib short aliases mapped via HoloViews
(e.g., '+', 's', 'd', '^', '>', 'v', '<', '1', '2', '3', '4', 'o', '*').
See https://docs.bokeh.org/en/latest/docs/examples/basic/scatters/markertypes.html
for the complete list of Bokeh markers.
- Matplotlib: 's' (square), 'x' (cross), '+', 'o' (circle), etc.
See https://matplotlib.org/stable/api/markers_api.html
for the complete list of Matplotlib markers.
c : str, optional
Field name to color markers by, or a single color name. Alias for ``color``.
s : int, optional
Expand Down Expand Up @@ -1338,8 +1340,11 @@ def points(self, x=None, y=None, **kwds):
s : int, optional
The size of the marker. Also available as 'size'.
marker : str, optional
The marker shape specified above can be any supported by matplotlib, e.g. s, d, o etc.
See https://matplotlib.org/stable/api/markers_api.html.
The marker shape style to use. Supports standard Bokeh marker names
(e.g., 'circle', 'square', 'triangle', 'cross', 'diamond', 'asterisk') as well as
Matplotlib short aliases mapped via HoloViews (e.g., '+', 's', 'd', '^', '>', 'v', '<', '1', '2', '3', '4', 'o', '*').
See https://docs.bokeh.org/en/latest/docs/examples/basic/scatters/markertypes.html
and https://matplotlib.org/stable/api/markers_api.html.
scale : float, optional
Scaling factor to apply to point scaling. Default is 1.
logz : bool, optional
Expand Down