Simplify upgrade section in the readme as currently it is talking about breaking changes in v1.2 (and there already was v2 with additional changes) #565
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@kavalerov do we still want to land this one? |
|
@jamienewcomb I would love to, yes, just was waiting for some sort of review :) I cannot add reviewers to the PR. |
|
@ttypic thanks for review. I am afraid I am not authorised to merge, so will leave this to you. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As you can see here https://github.com/ably/ably-python?tab=readme-ov-file#breaking-api-changes-in-version-120 there is a whole section in the Readme related to changes in the version 1.2. However, there already was another major version release since then.
This can be a bit confusing, and as we list all breaking changes in Migration Guide. This PR suggests a simpler readme section that just points to the migration guide.