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

Sound split fixes in GUI and User Guide #16609

Merged
merged 2 commits into from
May 26, 2024
Merged

Conversation

CyrilleB79
Copy link
Collaborator

@CyrilleB79 CyrilleB79 commented May 25, 2024

Link to issue number:

None

Summary of the issue:

Various issues found in Sound Split feature description in the User Guide and in the GUI:

  • The User Guide does not explain the difference between "Sound split disabled" mode and "NVDA in both channels and applications in both channels" mode.
  • In the User Guide, the default option is called "Disabled sound split", but "Sound split disabled" in the GUI.
  • In the User Guide, the description of the way to restore the sound in both channels after a crash is not always correct, especially now that the "disabled" option does not modify audio processing at all.
  • The GUI warning when unchecking the Disabled mode is not correct since there are various other possible modes with speech in both channels (among them the new "NVDA both and app both"). The removal of this warning had been discussed and approved in Sound split #16071 (comment) but never completed.

Description of user facing changes

  • User Guide updated for 3 first items.
  • Warning removed from the GUI

Description of development approach

N/A

Testing strategy:

  • Check the generated User Guide.
  • Manual check of the GUI

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
Copy link
Collaborator Author

Cc @mltony, @LeonarddeR for review / corrections if needed.

@CyrilleB79 CyrilleB79 changed the title Sound split fixes in User Guide Sound split fixes in GUI and User Guide May 26, 2024
@CyrilleB79 CyrilleB79 marked this pull request as ready for review May 26, 2024 21:43
@CyrilleB79 CyrilleB79 requested review from a team as code owners May 26, 2024 21:43
@CyrilleB79 CyrilleB79 requested review from Qchristensen and seanbudd and removed request for a team May 26, 2024 21:43
Copy link
Member

@seanbudd seanbudd left a comment

Choose a reason for hiding this comment

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

Thanks @CyrilleB79

@seanbudd seanbudd merged commit f530805 into nvaccess:beta May 26, 2024
1 check passed
@seanbudd seanbudd added this to the 2024.2 milestone May 26, 2024
@CyrilleB79 CyrilleB79 deleted the sndSplitFix branch May 27, 2024 20:33
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.

2 participants