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.

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

Use @deprecated decorator for deprecated classes. #1468

Open
JoerivanEngelen opened this issue Feb 28, 2025 · 0 comments
Open

Use @deprecated decorator for deprecated classes. #1468

JoerivanEngelen opened this issue Feb 28, 2025 · 0 comments

Comments

@JoerivanEngelen
Copy link
Contributor

JoerivanEngelen commented Feb 28, 2025

@Manangka came with this good suggestion in PR #1463 to mark deprecated functions/classes:

https://deprecated.readthedocs.io/en/latest/sphinx_deco.html#more-elaborate-example

But unfortunately when I tried it, I got a weird error message from sphinx autosummary:

sphinx.errors.ExtensionError: Handler <function process_generate_options at 0x00000178ADD19580> for event 'builder-inited' threw an exception (exception: no module named imod.evaluate)

But as far as I could tell, there normally is no issue with this module, the API docs for this module render fine.
As a builtin deprecated decorator will be included somewhere in Python >3.13, it is something interesting to pursue then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📯 New
Development

No branches or pull requests

1 participant