Add ability to speak character when cursor routing #8
Conversation
![korbit-ai[bot]](https://avatars.githubusercontent.com/in/322216?s=60&v=4){kind=small}
|
Clone of the PR nvaccess/nvda#16947 |
![[development] Korbit - AI Mentor](https://avatars.githubusercontent.com/in/334508?s=40&u=8e7ea115878aacba56242d7ac87807ea98eac709&v=4){kind=avatar}
|
👋 I'm here to help you review your pull request. When you're ready for me to perform a review, you can comment anywhere on this pull request with this command: As a reminder, here are some helpful tips on how we can collaborate together:
|
|
My review is in progress 📖 - I will have feedback for you in a few minutes! |
WalkthroughThe changes introduce a new feature in NVDA that allows the application to vocalize the character at the cursor position when routing occurs using braille input. This feature is controlled by a new configuration option, Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant BrailleDisplay
participant Config
participant Speech
User->>BrailleDisplay: Route cursor
BrailleDisplay->>Config: Check speakOnRouting setting
alt speakOnRouting is enabled
BrailleDisplay->>Speech: Speak character at cursor
end
Recent review detailsConfiguration used: .coderabbit.yml Files selected for processing (6)
Additional context usedPath-based instructions (6)
Additional comments not posted (6)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (1)
user_docs/en/userGuide.md (1)
2253-2258: Ensure adherence to the one-sentence-per-line style.The new section is clear and well-written. However, ensure that each sentence is on a new line to adhere to the one-sentence-per-line style used in the rest of the document.
##### Speak character when routing cursor in text {#BrailleSettingsSpeakOnRouting} If this is enabled, NVDA will automatically speak the character at the cursor when routing to it with braille cursor routing keys. To toggle this option from anywhere, please assign a custom gesture using the [Input Gestures dialog](#InputGestures).
| * When performing a braille cursor routing action, NVDA can now automatically speak the character ath the cursor. (#8072, @LeonarddeR) | ||
| * This option is disabled by default. You can enable "Speak character when routing cursor in text" in NVDA's braille settings. |
There was a problem hiding this comment.
Fix typographical error.
There is a typographical error in the word "ath". It should be "at".
Apply this diff to fix the error:
- * When performing a braille cursor routing action, NVDA can now automatically speak the character ath the cursor. (#8072, @LeonarddeR)
+ * When performing a braille cursor routing action, NVDA can now automatically speak the character at the cursor. (#8072, @LeonarddeR)Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * When performing a braille cursor routing action, NVDA can now automatically speak the character ath the cursor. (#8072, @LeonarddeR) | |
| * This option is disabled by default. You can enable "Speak character when routing cursor in text" in NVDA's braille settings. | |
| * When performing a braille cursor routing action, NVDA can now automatically speak the character at the cursor. (#8072, @LeonarddeR) | |
| * This option is disabled by default. You can enable "Speak character when routing cursor in text" in NVDA's braille settings. |
Link to issue number:
Closes #8072
Summary of the issue:
When cursor routing, it can sometimes be handy if speech follows along and tells you what character you moved to, especially when the character in braille is unknown to you.
Description of user facing changes
Description of development approach
Added a new option to the config spec, as well as a function to braille to speak the character at the given position. Also added an item to the settings panel as well as an unbound global command.
Testing strategy:
Known issues with pull request:
None known
Code Review Checklist:
Summary by CodeRabbit
New Features
Documentation
Description by Korbit AI
What change is being made?
Add functionality to speak the character at the cursor position when performing a braille cursor routing action, with a toggle option in the settings.
Why are these changes being made?
This change enhances accessibility by providing auditory feedback for users who rely on braille displays, allowing them to confirm the character they are routing to. The feature is optional and can be enabled in the braille settings, offering flexibility to users who may or may not want this auditory feedback.