Skip to content

Fixed a deprecation message and associated docstrings#19785

Merged
seanbudd merged 2 commits into
nvaccess:betafrom
CyrilleB79:deprecMsg
Mar 16, 2026
Merged

Fixed a deprecation message and associated docstrings#19785
seanbudd merged 2 commits into
nvaccess:betafrom
CyrilleB79:deprecMsg

Conversation

@CyrilleB79

Copy link
Copy Markdown
Contributor

Opened against beta since:

  • 2026.1 beta cycle is the most privileged time for add-on authors to have a look at deprecation messages.
  • This PR is low risk: only log message string and docstrings are modified.

Link to issue number:

None

Summary of the issue:

A deprecation message recommended to use gui.messageDialog.MessageDialog but the gui.message module does not exist.

Description of user facing changes:

The deprecation message will now mention gui.message.MessageDialog.

Description of developer facing changes:

Fixed both the deprecation message and docstrings mentioning the non-existing gui.messageDialog module.

Description of development approach:

String replacement. See diff

Testing strategy:

Manual test of the deprecation message.

Known issues with pull request:

None

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.

@CyrilleB79 CyrilleB79 requested a review from a team as a code owner March 12, 2026 14:49
@CyrilleB79 CyrilleB79 requested a review from seanbudd March 12, 2026 14:49
@CyrilleB79

Copy link
Copy Markdown
Contributor Author

The test failure seems unrelated with respect to the changes done here. Note that VSCode system test frequently fail in various recent PRs.

@wmhn1872265132

Copy link
Copy Markdown
Contributor

Please note that the current target branch of this PR is master

@CyrilleB79 CyrilleB79 changed the base branch from master to betaDocUpdates March 13, 2026 06:10
@CyrilleB79 CyrilleB79 changed the base branch from betaDocUpdates to beta March 13, 2026 07:22
@seanbudd seanbudd added this to the 2026.1 milestone Mar 16, 2026
@seanbudd seanbudd merged commit 8254d64 into nvaccess:beta Mar 16, 2026
39 of 41 checks passed
@CyrilleB79 CyrilleB79 deleted the deprecMsg branch March 19, 2026 07:26
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.

3 participants