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

Implement an extension point deprecation strategy #17644

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

LeonarddeR
Copy link
Collaborator

Link to issue number:

Follow up of #17011
Slightly related to #17635, as this oversight was found there

Summary of the issue:

In #17011, braille.filter_displaySize was deprecated, but there was not yet a mechanism in place that logs warnings about usage of the deprecated extension point.

Description of user facing changes

Warnings in the log when braille.filter_displaySize.register is called.

Description of development approach

  1. Added an optional keyword argument _deprecationmessage to HandlerRegistrar. If set, it will be logged when a handler is registered.
  2. Removed remaining handlers in core, changed them into handlers for filter_displayDimensions
  3. Unit test expansion, missing tests for filter_displayDimensions

Testing strategy:

Tested that a warning is logged when registering

Known issues with pull request:

None known

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

@coderabbitai summary

@LeonarddeR LeonarddeR requested a review from a team as a code owner January 23, 2025 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant