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 a changelog #507

Closed
asmeurer opened this issue Nov 14, 2022 · 2 comments
Closed

Add a changelog #507

asmeurer opened this issue Nov 14, 2022 · 2 comments
Labels
Narrative Content Narrative documentation content.
Milestone

Comments

@asmeurer
Copy link
Member

We should add a changelog that lists all the changes between versions. That will make it easier for implementers to see what they need to update in their implementations.

Additionally, we can use the versionadded and versionchanged Sphinx directives (https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded) to add a note to each respective function about things that have changed, which will make it easier to see what changed for a specific functionality.

@kgryte kgryte added this to the v2022 milestone Dec 15, 2022
@kgryte kgryte added the Narrative Content Narrative documentation content. label Dec 15, 2022
@rgommers
Copy link
Member

The changelog has been added in gh-574. The versionadded and versionchanged directives can be added based on that later - that'll be a task for after the v2022 release

@rgommers rgommers modified the milestones: v2022, v2023 Dec 15, 2022
@kgryte
Copy link
Contributor

kgryte commented Feb 9, 2023

versionadded and versionchanged directives have been added to the specification. As such, will go ahead and close this one out.

@kgryte kgryte closed this as completed Feb 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Narrative Content Narrative documentation content.
Projects
None yet
Development

No branches or pull requests

3 participants