Document Grid and Legend Options #1576
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
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation by adding Grid and Legend options to the reference docs, addressing issue #1575.
- Added a hyperlink and navigation entry in the plotting options index.
- Introduced a new notebook (grid_legend.ipynb) documenting the Grid and Legend options with relevant examples.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| doc/ref/plotting_options/index.md | Added a link to the new grid_legend page and updated table navigation. |
| doc/ref/plotting_options/grid_legend.ipynb | Contains a new notebook with detailed examples on grid and legend options. |
maximlt
requested changes
May 15, 2025
| "(option-legend)=\n", | ||
| "## `legend`\n", | ||
| "\n", | ||
| "Controls whether and where the legend appears. Use `legend=True` (or `legend='right'`) to show it in the default position, `legend=False` to hide it, or supply one of ('top','bottom','left','right') to choose its placement." |
There was a problem hiding this comment.
It accepts other options like bottom_left. Can you please find out all the options it accepts (check if they work for bokeh and matplotlib just in case) and list them all? The docstring needs to be updated too.
Maybe in future we will have more options in this section :) |
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 #1575
This PR adds the Grid and Legend options to the reference docs.