Skip to content

Updated the doc for the scratchpad option#14788

Merged
seanbudd merged 1 commit intonvaccess:masterfrom
CyrilleB79:scratchpadDoc
Apr 5, 2023
Merged

Updated the doc for the scratchpad option#14788
seanbudd merged 1 commit intonvaccess:masterfrom
CyrilleB79:scratchpadDoc

Conversation

@CyrilleB79
Copy link
Copy Markdown
Contributor

@CyrilleB79 CyrilleB79 commented Apr 4, 2023

Link to issue number:

Closes #14773

Summary of the issue:

In #14773, the user wanted to document when the code is loaded from the scratchpad directory.

Description of user facing changes

As discussed in the issue, it is hard to add more details in the GUI. Thus, the User Guide's paragraph describing this option has been updated. Not that it is easily reachable from the GUI thanks to context help.

The following updates have been made:

  • Added a sentence to indicate when all the modules from the scratchpad are loaded
  • Added visual enhancement providers to the list of the modules that can be loaded from the scratchpad.
  • Removed the sentence comparing the current situation with older versions of NVDA when the scratchpad did not exist and test modules were directly loaded from appModule, globalPlugins, etc. subfolders. Indeed, the scratchpad has been introduced in NVDA 2019.1, which is now quite old.

Description of development approach

N/A

Testing strategy:

Generated the documentation and checked it; also checked the link.

Known issues with pull request:

None

Change log entries:

Not needed.

Code Review Checklist:

  • Pull Request description:
    • description is up to date
    • change log entries
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • API is compatible with existing add-ons.
  • Documentation:
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • Security precautions taken.

@CyrilleB79
Copy link
Copy Markdown
Contributor Author

@fernando-jose-silva you may want to have a look at this PR.

@CyrilleB79 CyrilleB79 marked this pull request as ready for review April 4, 2023 21:43
@CyrilleB79 CyrilleB79 requested a review from a team as a code owner April 4, 2023 21:43
@CyrilleB79 CyrilleB79 requested a review from Qchristensen April 4, 2023 21:43
@fernando-jose-silva
Copy link
Copy Markdown

fernando-jose-silva commented Apr 5, 2023 via email

@seanbudd seanbudd merged commit e82d24c into nvaccess:master Apr 5, 2023
@nvaccessAuto nvaccessAuto added this to the 2023.2 milestone Apr 5, 2023
@CyrilleB79 CyrilleB79 deleted the scratchpadDoc branch April 5, 2023 20:10
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.

Improve documentation for "Enable loading code from developer working directory"

4 participants