Skip to content

Remove the support of non-aliased aliases in use_alias/fmt_docstrings #4042

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

seisman
Copy link
Member

@seisman seisman commented Aug 10, 2025

In PR #3965, we modified the use_alias/fmt_docstrings decorators to automatically list the non-aliased aliases in docstrings. The workarounds work as expected but have some limitations (e.g., #3965 (comment)).

Since we're slowly migrating to the new alias system (#3239), and getting rid of the {aliases} placeholder, the workarounds are no longer needed and can be removed.

This PR reverts the changes in #3965.

@seisman seisman added this to the 0.17.0 milestone Aug 10, 2025
@seisman seisman added maintenance Boring but important stuff for the core devs needs review This PR has higher priority and needs review. and removed needs review This PR has higher priority and needs review. labels Aug 10, 2025
@seisman seisman marked this pull request as draft August 10, 2025 11:32
@seisman seisman marked this pull request as ready for review August 10, 2025 11:56
@seisman seisman added the needs review This PR has higher priority and needs review. label Aug 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs needs review This PR has higher priority and needs review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant