Skip to content

Documentation fix-up for new winAPI.secureDesktop.post_secureDesktopStateChange extensionPoint#15392

Merged
seanbudd merged 4 commits into
nvaccess:masterfrom
XLTechie:addMissingExtPoint
Sep 8, 2023
Merged

Documentation fix-up for new winAPI.secureDesktop.post_secureDesktopStateChange extensionPoint#15392
seanbudd merged 4 commits into
nvaccess:masterfrom
XLTechie:addMissingExtPoint

Conversation

@XLTechie

@XLTechie XLTechie commented Sep 7, 2023

Copy link
Copy Markdown
Collaborator

Link to issue number:

Fix-up of #14488

Summary of the issue:

In #14488, no documentation for the new extensionPoint was added to the master list of extension points in the developer guide.
(I wish there was a way to remind of this when contributing extensionPoint creations)

Additionally, I noticed an oddity in the documentation of the extensionPoint itself, which may or may not be intended.

Description of user facing changes

Improved documentation for developers.

Description of development approach

  • Added a new section to the Developer Guide chapter on Extension Points, listing the new Action, winAPI.secureDesktop.post_secureDesktopStateChange.
  • Fixed a terminology error in the head section of the chapter (I had previously called extensionPoints a module, when it should have been a package).
  • Noticed that in the usage example given in the winAPI.secureDesktop module docstring, there was a call to notify(). AFAIK, the general consumer of this extensionPoint, who registers something to it, shouldn't also be calling notify on it. I removed that example line, replacing it with a comment to put the subsequent unregister() call in context. @seanbudd please check my reasoning.

Testing strategy:

None needed.

Known issues with pull request:

None.

Change log entries:

None.

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.

@XLTechie XLTechie marked this pull request as ready for review September 7, 2023 09:39
@XLTechie XLTechie requested a review from a team as a code owner September 7, 2023 09:39
@XLTechie XLTechie requested a review from seanbudd September 7, 2023 09:39
@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit 8851d690a9

@seanbudd seanbudd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this

@seanbudd seanbudd merged commit 87f7870 into nvaccess:master Sep 8, 2023
@nvaccessAuto nvaccessAuto added this to the 2024.1 milestone Sep 8, 2023
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.

4 participants