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

versioning packages should render version #20

Open
edublancas opened this issue Dec 29, 2022 · 0 comments
Open

versioning packages should render version #20

edublancas opened this issue Dec 29, 2022 · 0 comments

Comments

@edublancas
Copy link
Collaborator

We want to include the next release version in the source code in a few cases. For example, when using .. versionadded::, .. versionchanged::, or when deprecating features. However, the code author might not know which the next release.

The idea is to have placeholders that render when creating a new version. e.g.,

warn("X was renamed to Y in version {VERSION_NEXT} and X will be removed in {VERSION_DEPRECATE}", FutureWarning)

We should also keep track of {VERSION_DEPRECATE} so when we reach such version, we do not forget to deprecate them. Maybe we can store a .deprecations JSON file that keeps track of these things.

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

No branches or pull requests

1 participant