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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Documentation of breaking changes #20

Open
4 tasks
MatrixEditor opened this issue Jan 16, 2025 · 0 comments
Open
4 tasks

[DOCS] Documentation of breaking changes #20

MatrixEditor opened this issue Jan 16, 2025 · 0 comments
Assignees
@MatrixEditor
Labels
Priority: Medium Status: Confirmed Type: Documentation

Comments

@MatrixEditor
Copy link
Owner

Breaking changes should be documented more explicitly. Therefore, what should be done:

  • Create a documentation page that lists/references all breaking changes
  • Each breaking change should be documented in its corresponding class using .. versionchanged::
  • The main README should contain a link to a list of all breaking changes
  • Warnings should be added (where appropriate) to support UX - e.g. str as second parameter of Prefixedshould result in a warning that points out the breaking change
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MatrixEditor MatrixEditor

Labels
Priority: Medium Status: Confirmed Type: Documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MatrixEditor