Skip to content

Organize API changes in the release notes by severity #5354

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

Closed
michaelosthege opened this issue Jan 14, 2022 · 3 comments · Fixed by #5832
Closed

Organize API changes in the release notes by severity #5354

michaelosthege opened this issue Jan 14, 2022 · 3 comments · Fixed by #5832
Assignees
Labels
Milestone

Comments

@michaelosthege
Copy link
Member

michaelosthege commented Jan 14, 2022

The list of breaking changes in the RELEASE-NOTES.md is quite long, but most of these are only relevant for a tiny fraction of users/models.

To make the release notes less deterrent, we should split the API changes into two sections.
Something like:

  • Important API changes
  • Internal/Advanced API changes

An example: With #5320 the old Model.logpt property became a method and many other model properties were removed. Of these breaks Model.logpt → Model.logpt() is probably the only one worth mentioning for the "important" section.

@ricardoV94 ricardoV94 added this to the v4.0.0 milestone Jan 14, 2022
@soma2000-lang
Copy link
Contributor

soma2000-lang commented Mar 19, 2022

@michaelosthege I want to work on this issue but how can I know that among so many APIs ,which one I included in the advanced ones and which one as important.

@michaelosthege
Copy link
Member Author

@michaelosthege I want to work on this issue but how can I know that among so many APIs ,which one I included in the advanced ones and which one as important.

This is not really a beginner friendly issue. Please do one issue at a time. There are several others you wanted to work on.

@AlexAndorra
Copy link
Contributor

Will work on that starting tomorrow 😉

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

Successfully merging a pull request may close this issue.

4 participants