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

3.0 backwards compatibility breaks #268

Closed
11 tasks done
lemon24 opened this issue Jan 2, 2022 · 2 comments
Closed
11 tasks done

3.0 backwards compatibility breaks #268

lemon24 opened this issue Jan 2, 2022 · 2 comments

Comments

@lemon24
Copy link
Owner

lemon24 commented Jan 2, 2022

This is to track all the backwards compatibility breaks we want to do in 3.0.

Things that require deprecation warnings pre-3.0:

Things that do not require / can't have deprecation warnings pre-3.0:

  • (done in 2.7) rename the mark_as_read config tag from .reader.mark_as_read to .reader.mark-as-read
    • remove pre-2.7 config migration
  • delete old metadata exceptions; Consider merging tags and metadata #266 (comment)
  • drop all 2.x migrations; the upgrade path from reader 2.x to reader 3 will require upgrading to reader 2.latest first
  • use positional-only parameters, where possible (after Drop Python 3.7 support #278 is done)
    • in theory, it is possible to raise deprecation warnings for this (example), it's just too much work
  • TagError(key, resource_id) -> TagError(resource_id, key)
  • plugin_func(reader) exceptions in make_reader() should be wrapped in PluginError
@lemon24
Copy link
Owner Author

lemon24 commented Jul 19, 2022

To do for object_id -> resource_id:

  • add new, deprecate old
  • update lib usage and tests
  • rename storage ResourceId arguments
  • update web app usage and tests
  • changelog (include TagError signature change?)
  • guide
  • final grep, diff check

lemon24 added a commit that referenced this issue Jul 19, 2022
lemon24 added a commit that referenced this issue Jul 20, 2022
lemon24 added a commit that referenced this issue Jul 20, 2022
lemon24 added a commit that referenced this issue Jul 23, 2022
lemon24 added a commit that referenced this issue Jul 23, 2022
lemon24 added a commit that referenced this issue Jul 23, 2022
lemon24 added a commit that referenced this issue Jul 24, 2022
lemon24 added a commit that referenced this issue Jul 24, 2022
lemon24 added a commit that referenced this issue Jul 24, 2022
lemon24 added a commit that referenced this issue Jul 24, 2022
lemon24 added a commit that referenced this issue Jul 24, 2022
lemon24 added a commit that referenced this issue Jul 25, 2022
lemon24 added a commit that referenced this issue Jul 25, 2022
lemon24 added a commit that referenced this issue Jul 25, 2022
lemon24 added a commit that referenced this issue Jul 25, 2022
lemon24 added a commit that referenced this issue Jul 25, 2022
lemon24 added a commit that referenced this issue Jul 25, 2022
lemon24 added a commit that referenced this issue Jul 30, 2022
@lemon24
Copy link
Owner Author

lemon24 commented Jul 30, 2022

3.0 released, resolving.

@lemon24 lemon24 closed this as completed Jul 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant