Skip to content

Add translator comments for several missing strings#19313

Draft
rrajput22 wants to merge 1 commit intonvaccess:masterfrom
rrajput22:add-translator-comments
Draft

Add translator comments for several missing strings#19313
rrajput22 wants to merge 1 commit intonvaccess:masterfrom
rrajput22:add-translator-comments

Conversation

@rrajput22
Copy link

@rrajput22 rrajput22 commented Dec 2, 2025

Link to issue number:

Summary of the issue: Several translatable strings in source/controlTypes/role.py were missing translator comments. These strings are listed in tests/checkPot.py under EXPECTED_MESSAGES_WITHOUT_COMMENTS, meaning the NVDA team has specifically identified them as needing comments for proper localization.

Description of user facing changes: No user-facing functional changes. This PR only improves translator guidance for localization teams by adding context comments.

Description of developer facing changes: Added translator comments (#. Translators: …) above several role entries in role.py. These comments help translators understand the meaning and context of UI strings such as “border”, “filler”, “line”, “calendar”, “video”, “audio”, “data item”, and “header item”.

Description of development approach:

  • Located missing strings listed in tests/checkPot.py
  • Searched the codebase to identify where each string is defined
  • Added translator comments using existing commenting conventions
  • Ensured comments describe the UI element clearly and concisely
  • Avoided changing any functionality or string identifiers
  • Kept each change scoped and consistent with NVDA's documentation patterns

Testing strategy:

  • Verified that each modified string is included in
  • EXPECTED_MESSAGES_WITHOUT_COMMENTS
  • Ensured translator comments follow existing patterns in role.py
  • Confirmed that no behavior, values, or translations were altered
  • Manual check through GitHub diff to ensure only comments were added

Known issues with pull request: None. Changes are strictly additive comments and do not impact runtime behavior.

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.

@rrajput22 rrajput22 requested a review from a team as a code owner December 2, 2025 04:59
@rrajput22 rrajput22 marked this pull request as draft December 2, 2025 05:00
@rrajput22 rrajput22 marked this pull request as ready for review December 2, 2025 05:16
@seanbudd
Copy link
Member

seanbudd commented Dec 2, 2025

Hi - please make sure that the "check translator comments" test passes

@seanbudd
Copy link
Member

seanbudd commented Dec 2, 2025

you can do this by modifying tests/checkPot

@CyrilleB79
Copy link
Contributor

Could you please edit the initial description of this PR to do the following changes:

  1. Mention Help localization of NVDA in new languages by adding the missing translators comments #11104, e.g.:
### Link to issue number:
Partial fix for #11104
  1. Could you take care to add your answer not after the heading but below, after a newline. E.g.:
    Instead of:
### Description of user facing changes: No user-facing functional changes. This PR only improves translator guidance for localization teams by adding context comments.

Do as follows:

### Description of user facing changes:
No user-facing functional changes. This PR only improves translator guidance for localization teams by adding context comments.

@seanbudd seanbudd marked this pull request as draft December 3, 2025 03:07
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Dec 4, 2025
@seanbudd
Copy link
Member

seanbudd commented Feb 3, 2026

Hi @rrajput22 to you intend to work on this?

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.

3 participants