Add docstrings needed to help a user create a simple Scatter example#5363
Open
MarcSkovMadsen wants to merge 2 commits intomainfrom
Open
Add docstrings needed to help a user create a simple Scatter example#5363MarcSkovMadsen wants to merge 2 commits intomainfrom
MarcSkovMadsen wants to merge 2 commits intomainfrom
Conversation
philippjfr
reviewed
Sep 24, 2022
holoviews/element/chart.py
Outdated
| dependent relationships between the x and y axes in two-dimensional space, | ||
| such as Chart types like `Curve`. | ||
|
|
||
| Reference: [Bokeh](http://holoviews.org/reference/elements/bokeh/Scatter.html), [Matplotlib](http://holoviews.org/reference/elements/matplotlib/Scatter.html), [Plotly](http://holoviews.org/reference/elements/plotly/Scatter.html) |
Member
There was a problem hiding this comment.
What link formatting will work? I'd be happy to see this merged once the links are formatted in a usable way.
Member
There was a problem hiding this comment.
I think markdown is fine for vs code tooltips but for ref API I think it needs to be reST
philippjfr
reviewed
May 17, 2024
philippjfr
reviewed
May 17, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This addresses a small part of #5361 by adding docstrings to
Scatterand.optsas well as updating the docstring ofOpts.For me this makes it so much easier to understand the objects and navigate the documentation.
holoviews-docstring-improvements.mp4