Skip to content

Report grammar errors according to configuration#19257

Merged
seanbudd merged 14 commits into
nvaccess:masterfrom
nvdaes:grammar
Dec 5, 2025
Merged

Report grammar errors according to configuration#19257
seanbudd merged 14 commits into
nvaccess:masterfrom
nvdaes:grammar

Conversation

@nvdaes

@nvdaes nvdaes commented Nov 21, 2025

Copy link
Copy Markdown
Collaborator
  • Fix grammar reporting
  • Report grammar errors in braille
  • Update user guide
  • Add grammarError sound from Pixabay
  • Rename spelling errors in document formatting to include grammar errors
  • Mention grammar errors in changelog

Link to issue number:

Fixes #19218

Summary of the issue:

Grammar errors are spoken when NVDA is configured to report them with sounds or in braille.

Description of user facing changes:

  • Grammar errors Will be reported according to the selected settings.
  • In the Document Formatting dialog, "Spelling errors" has been renamed to "Spelling or gramar errors".
  • "grammar" has been included in messages and descriptions of commands to toggle the reporting of errors via audio and in braille.

Description of developer facing changes:

None.

Description of development approach:

  • In speech.speak.py, seen how the "invalid-spelling" attribute is addressed, to handle the "invalid-grammar" attribute appropriately.
  • In braille.py, "invalid-grammar" has been added to fontAttributeFormattingMarkers.

Testing strategy:

Tested the different ways of reporting spelling and gramar errors.

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.

@nvdaes

nvdaes commented Nov 21, 2025

Copy link
Copy Markdown
Collaborator Author

I'm using a sound downloaded From Pixabay. Here's the summary of the license contents.
I've converted the sound to wav from mp3:

https://pixabay.com/service/license-summary

@nvdaes nvdaes marked this pull request as ready for review November 22, 2025 13:37
@nvdaes nvdaes requested review from a team as code owners November 22, 2025 13:37
Comment thread user_docs/en/changes.md Outdated
Comment thread source/waves/grammarError.wav Outdated
Comment thread source/globalCommands.py Outdated
Comment thread source/globalCommands.py Outdated
Comment thread source/globalCommands.py Outdated

@CyrilleB79 CyrilleB79 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for taking this.

nvdaes and others added 5 commits November 24, 2025 07:04
Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>
Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>
Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>
Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Nov 25, 2025

@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.

Nice, thanks @nvdaes

Comment thread user_docs/en/userGuide.md Outdated
Co-authored-by: Sean Budd <seanbudd123@gmail.com>
@nvdaes

nvdaes commented Dec 5, 2025

Copy link
Copy Markdown
Collaborator Author

@seanbudd @Qchristensen , let's accept Sean's suggestion. The sound was described with two words since I tried to add two different sounds, but finally we decided to add just one sound in this PR.

@nvdaes

nvdaes commented Dec 5, 2025

Copy link
Copy Markdown
Collaborator Author

For me this is ready.

@Qchristensen Qchristensen 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.

Reads well, and I agree with Sean's suggested change to remove "or glitch" from the the "short buzzer or glitch" line.

Comment thread user_docs/en/userGuide.md Outdated
@seanbudd seanbudd merged commit 79a07dc into nvaccess:master Dec 5, 2025
16 of 41 checks passed
@github-actions github-actions Bot added this to the 2026.1 milestone Dec 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Grammar errors are spoken when NVDA is configured to report them in braille or playing sounds

4 participants