Skip to content

[DOCS] Documentation of breaking changes #20

@MatrixEditor

Description

@MatrixEditor

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

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions