DOC: Clarify Coords Report Example #21745
Merged
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.
PR Summary
The coord reports example prominently shows the plot produced by the example. This can be a bit midleading as the demonstrated feature is only visible in the interactive backend. As this can lead to some confusion (see e.g. #2205), I added a short explanatory remark.
(the same pertains to the modifying the coordinate formatter example)
PR Checklist
Tests and Styling
pytest
passes).flake8-docstrings
and runflake8 --docstring-convention=all
).Documentation
[N/A] New features are documented, with examples if plot related.
[N/A] New features have an entry in
doc/users/next_whats_new/
(follow instructions in README.rst there).[N/A] API changes documented in
doc/api/next_api_changes/
(follow instructions in README.rst there).