Document the data options #1555
Merged
Conversation
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
maximlt
approved these changes
May 13, 2025
Member
maximlt
left a comment
maximlt
left a comment
There was a problem hiding this comment.
I've pushed a few changes:
- Using one rst admonition in the converter docstring
- Format the code
- Update a couple of links to HoloViews to avoid pointing to the reference but to the gallery instead as it's more user-friendly
- Fix broken links (building the docs showed 8 warnings) by declaring MyST explicit targets and using them
- Use seealso admonition on the data page as it looks prettier
Comment on lines
+155
to
+156
| .. note:: | ||
| ``group_label`` only applies when plotting multiple columns and does not control grouping with ``by``. |
Member
There was a problem hiding this comment.
The docs immediately look much better when using rst admonitions in the converter docstring, don't hesitate to use them more.
Collaborator
Author
|
Thanks, I'll incorporate these additions to the new PRs |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
fixes #1538
This PR documents the
Data Optionsin the new API reference guide.