Skip to content

Minor fixes in the User Guide and a GUI label regarding annotations options group - #12781

Merged
michaelDCurran merged 1 commit into
nvaccess:masterfrom
CyrilleB79:fixupAnnotations
Aug 25, 2021
Merged

Minor fixes in the User Guide and a GUI label regarding annotations options group#12781
michaelDCurran merged 1 commit into
nvaccess:masterfrom
CyrilleB79:fixupAnnotations

Conversation

@CyrilleB79

@CyrilleB79 CyrilleB79 commented Aug 25, 2021

Copy link
Copy Markdown
Contributor

Link to issue number:

None.
Minor fixes of issues introduced by #12409 and #12500.
See @k-kolev1985 message in this thread on NVDA translation mailing-list for the initial reporting.

Summary of the issue:

  1. An option group is named "Annotations" in the Advanced settings panel. But the corresponding paragraph in the User Guide is still named with the old name "Enable Experimental ARIA annotations"
  2. In advanced settings panel the option "Report aria-description always:" has a typo: an extra colon character.

Description of how this pull request fixes the issue:

  1. I have made the User Guide paragraph title match the option group it is describing. While at it, I have also modified the first sentence of the paragraph to make it a complete grammatically correct sentence; and it makes clearer the fact that this paragraph describes a group of option while the neighbouring paragraphs describle single options.

Testing strategy:

  • Checked the typo running from cource
  • Checked the generated user guide from appVeyor
  • Checked that context help still works in this group of options

Known issues with pull request:

Issue 2. is present in NVDA 2021.2beta1. However, since we are already in the translation freeze, I fear we cannot submit PR's affecting the User Guide targetting the beta branch.
Let me know if I am mistaken; in this case, I may open a separate PR for point 2. against targetting beta branch.
If on the contrary you confirm me that we cannot add User Guide changes in the beta branch, I may send an e-mail to the translators so that they use the matching group name in their translation. Thus the English User Guide may have the mistake but not the translated ones.

Change log entries:

Not needed.

Code Review Checklist:

  • Pull Request description is up to date.
  • Unit tests.
  • System (end to end) tests.
  • Manual testing.
  • User Documentation.
  • Change log entry.
  • Context sensitive help for GUI changes.
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers

@CyrilleB79
CyrilleB79 marked this pull request as ready for review August 25, 2021 16:19
@CyrilleB79
CyrilleB79 requested review from a team as code owners August 25, 2021 16:19
@michaelDCurran
michaelDCurran merged commit 16bbf7a into nvaccess:master Aug 25, 2021
@nvaccessAuto nvaccessAuto added this to the 2021.3 milestone Aug 25, 2021
@CyrilleB79
CyrilleB79 deleted the fixupAnnotations branch August 25, 2021 22:40
@CyrilleB79

Copy link
Copy Markdown
Contributor Author

@michaelDCurran, just to clarify, can you confirm explicitly that it is now too late to include the paragraph title modification in the beta branch? Thanks.

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