Skip to content

Magnifier - Small User Guide formatting#19769

Merged
seanbudd merged 1 commit into
nvaccess:masterfrom
CyrilleB79:ugFormatting
Mar 10, 2026
Merged

Magnifier - Small User Guide formatting#19769
seanbudd merged 1 commit into
nvaccess:masterfrom
CyrilleB79:ugFormatting

Conversation

@CyrilleB79

Copy link
Copy Markdown
Contributor

Link to issue number:

None

Summary of the issue:

In Magnifier documentation: bold is used at some places.
Such formatting has not been used until now in the User Guide, so we'd better be consistent here. It probably does not bring so much information for blind users who usually have not font attribute reporting enabled (speech / braille). Also worth noting that such formatting had been removed from NVDA remote documentatation when it has been integrated in NVDA's user guide. At last such formatting makes the translators work a bit harder, so if it's not necessary, let's not use it.

Also, a list is unwantedly split in two parts.

Description of user facing changes:

  • Removed bold formatting
  • Removed extra newline

Description of developer facing changes:

N/A

Description of development approach:

See diff

Testing strategy:

Check the generated User Guide.

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 10, 2026 12:55
@CyrilleB79 CyrilleB79 requested a review from Qchristensen March 10, 2026 12:55
@CyrilleB79

Copy link
Copy Markdown
Contributor Author

Not for NV Access: If we are willing to begin using bold formatting (or other types of formatting) in translated markdown, let's state it explicitely and let's discuss in which situation such formatting is accepted or even desirable. In this case, I'll close this PR (or restrict it to list merging).

Also cc @Boumtchack FYI, so that you can figure NV Access position for your future work.

@seanbudd seanbudd merged commit 776b9eb into nvaccess:master Mar 10, 2026
38 of 41 checks passed
@github-actions github-actions Bot added this to the 2026.2 milestone Mar 10, 2026
@CyrilleB79 CyrilleB79 deleted the ugFormatting branch March 12, 2026 06:51
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