Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Move deprecation notices to the top of docstrings #2637

Merged
merged 3 commits into from
Jan 5, 2025
Merged

Move deprecation notices to the top of docstrings #2637

merged 3 commits into from
Jan 5, 2025

Conversation

dstansby
Copy link
Contributor

@dstansby dstansby commented Jan 3, 2025

This avoids them being buried beneath long parameter descriptions, and follows the numpydoc style guide on deprecations.

@dstansby dstansby force-pushed the deprecation-docstrings branch from 9246446 to 1da9059 Compare January 3, 2025 18:42
@dstansby dstansby marked this pull request as ready for review January 4, 2025 09:27
normanrz
normanrz approved these changes Jan 4, 2025
View reviewed changes
Copy link
Member

@normanrz normanrz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great. I first put in the deprecation warnings up top, but then moved them down because of the linter.

@dstansby dstansby enabled auto-merge (squash) January 5, 2025 10:32
@dstansby dstansby merged commit 617e2cd into zarr-developers:main Jan 5, 2025
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@normanrz normanrz normanrz approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dstansby @normanrz