Closed jukent closed 7 months ago
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!
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/