Skip to content

Remove deprecated speechDictHandler.speechDictVars.#15629

Merged
seanbudd merged 1 commit into
nvaccess:masterfrom
lukaszgo1:I15614
Oct 15, 2023
Merged

Remove deprecated speechDictHandler.speechDictVars.#15629
seanbudd merged 1 commit into
nvaccess:masterfrom
lukaszgo1:I15614

Conversation

@lukaszgo1

Copy link
Copy Markdown
Contributor

Link to issue number:

Closes #15614

Summary of the issue:

speechDictHandler.speechDictVars was marked as deprecated in PR #15021. Unfortunately since the module was not imported anywhere in core py2exe failed to bundle it, which made it impossible to import this code in binary versions of NVDA. Additionally warning which was raised when importing speechDictHandler.speechDictVars was problematic when building developer documentation. Since this API breakage was already included in two releases of NVDA, it was decided to remove the code and document the removal.

Description of user facing changes

None - this only removes deprecated code.

Description of development approach

The deprecated code is removed. Change log is updated to document the removal for add-ons developers.

Testing strategy:

Verified the warnings are not shown when building developer documentation. Ensured entry was added into the change log. Made sure nothing in core imports from the removed module.

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.

@lukaszgo1 lukaszgo1 requested a review from a team as a code owner October 13, 2023 17:00
@lukaszgo1 lukaszgo1 requested a review from seanbudd October 13, 2023 17:00

@seanbudd seanbudd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @lukaszgo1

@seanbudd seanbudd merged commit 0c12057 into nvaccess:master Oct 15, 2023
@nvaccessAuto nvaccessAuto added this to the 2024.1 milestone Oct 15, 2023
@lukaszgo1 lukaszgo1 deleted the I15614 branch October 16, 2023 10:10
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.

speechDictHandler.speechDictVars should be either deprecated properly, or removed in 2024.1 cycle.

3 participants