Skip to content

Simplify getDocFilePath function#17911

Merged
seanbudd merged 6 commits into
nvaccess:betafrom
CyrilleB79:docCleaning
Apr 9, 2025
Merged

Simplify getDocFilePath function#17911
seanbudd merged 6 commits into
nvaccess:betafrom
CyrilleB79:docCleaning

Conversation

@CyrilleB79

@CyrilleB79 CyrilleB79 commented Apr 7, 2025

Copy link
Copy Markdown
Contributor

Link to issue number:

None; related to #13333.

Summary of the issue:

The file th\key commands.txt was an old outdated that was removed during the migration to Crowdin. Now the local documentations do not contain any old txt file, but getDocFilePath had still some unused code to handle these files.

Description of user facing changes

None.

Description of development approach

Remove dead code in both getDocFilePath functions.

While at it, updated .git-ignore to also ignore all the .md files that are generated when building the documentation (scons user_docs), since the source strings are now in .xliff files.

Testing strategy:

  • Test opening the documentation (user guide, key commands and change log) from NVDA menu
  • From Python console, test installer.getDocFilePath with the same files.
  • Test English, de and de_CH, trying to manually remove some documentation to simulate fallback or using other languages where documentation is missing (e.g. "am", "nb_NO")
  • Try to open licence file from installer (runnvda --launcher) and from NVDA menu

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.

@coderabbitai summary

@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Apr 8, 2025
@CyrilleB79

Copy link
Copy Markdown
Contributor Author

@seanbudd or @SaschaCowley: with this PR, getDocFilePath's behaviour would be modified, i.e. it won't accept anymore to open txt files in language folders, what is probably not done anymore for a long time.

Is this considered API breaking? And if yes, should I re-target to beta?

@seanbudd

seanbudd commented Apr 8, 2025

Copy link
Copy Markdown
Member

I think yes, let's retarget to beta for safety

@CyrilleB79 CyrilleB79 changed the base branch from master to beta April 8, 2025 09:37
@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit 3eddf8d7b8

@CyrilleB79 CyrilleB79 marked this pull request as ready for review April 8, 2025 21:13
@CyrilleB79 CyrilleB79 requested a review from a team as a code owner April 8, 2025 21:13
@CyrilleB79 CyrilleB79 requested a review from seanbudd April 8, 2025 21:13
Comment thread .gitignore Outdated
@seanbudd seanbudd merged commit b83b9c1 into nvaccess:beta Apr 9, 2025
@github-actions github-actions Bot added this to the 2025.2 milestone Apr 9, 2025
@CyrilleB79 CyrilleB79 deleted the docCleaning branch April 9, 2025 09:46
@seanbudd seanbudd modified the milestones: 2025.2, 2025.1 Apr 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api-breaking-change 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