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

Add .. versionadded:: directives when modifying APIs #7192

Open
jni opened this issue Aug 14, 2024 · 0 comments
Open

Add .. versionadded:: directives when modifying APIs #7192

jni opened this issue Aug 14, 2024 · 0 comments

Comments

@jni
Copy link
Member

jni commented Aug 14, 2024

📚 Documentation

The versionadded directive is a really nice way to tell users when particular arguments or functions were added to an API (example here). We haven't been using them in napari, which leads to some confusion about when particular APIs were added (who has time to read through a bunch of release notes?) and therefore what the minimum version of napari is to be able to use those APIs (ex: BiAPoL/napari-clusters-plotter#308 (comment)).

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

No branches or pull requests

1 participant