-
Notifications
You must be signed in to change notification settings - Fork 19
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.
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
Documentation improvement for TaylorDiagram class and set_titles_and_labels #219
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree this makes more sense.
A few typos and suggestions mentioned in the comments, but mostly wanted to raise a few questions about terminology (while we're making painful changes).
I wonder if we want to add some sort of deprecation warnings as well. Thoughts?
Co-authored-by: Katelyn FitzGerald <[email protected]>
Co-authored-by: Katelyn FitzGerald <[email protected]>
Co-authored-by: Katelyn FitzGerald <[email protected]>
Co-authored-by: Katelyn FitzGerald <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I might have spaced this before (apologies if so), but we should probably add either deprecation warnings or pending deprecation warnings and something in a deprecations section of the release notes about the renamed methods.
Otherwise, looks good.
Thanks @kafitzgerald just added them! |
src/geocat/viz/taylor.py
Outdated
""" | ||
|
||
warnings.warn( | ||
'This function is deprecated. Call `add_std_grid` instead.', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'This function is deprecated. Call `add_std_grid` instead.', | |
'`TaylorDiagram.add_ygrid` will be deprecated in the future. Please use `TaylorDiagram.add_std_grid` instead.', |
src/geocat/viz/taylor.py
Outdated
""" | ||
|
||
warnings.warn( | ||
'This function is deprecated. Call `add_corr_grid` instead.', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'This function is deprecated. Call `add_corr_grid` instead.', | |
'`TaylorDiagram.add_xgrid` will be deprecated in the future. Please use `TaylorDiagram.add_corr_grid` instead.', |
src/geocat/viz/taylor.py
Outdated
by array *arr* | ||
"""Add gridlines to the correlation axis specified by array *arr*. | ||
|
||
This function will be deprecated in favor of `add_corr_grid()` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This function will be deprecated in favor of `add_corr_grid()` | |
This method will be deprecated in favor of `TaylorDiagram.add_corr_grid` |
src/geocat/viz/taylor.py
Outdated
|
||
*arr*. | ||
|
||
This function will be deprecated in favor of `add_std_grid()` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This function will be deprecated in favor of `add_std_grid()` | |
This method will be deprecated in favor of `TaylorDiagram.add_std_grid`. |
Co-authored-by: Katelyn FitzGerald <[email protected]>
…into taylor-robust
PR Summary
Closes #176 and #212
PR Checklist
General
closes #XXX
to the PR description where XXX is the number of the issue.docs/release-notes.rst
in a relevant section for the next unreleased release. Possible sections include: Documentation, New Features, Bug Fixes, Internal Changes, Breaking Changes/Deprecatedprecommit
. To set up on your local, runpre-commit install
from the top level of the repository. To manually run pre-commits, usepre-commit run --all-files
and re-add any changed files before committing again and pushing.Documentation
_
) and have been added todocs/internal_api/index.rst
docs/user_api/index.rst
under their moduleExamples
docs/examples/
folderdocs/examples.rst
toctreedocs/gallery.yml
with appropriate thumbnail photo indocs/_static/thumbnails/