Documentation fix-up for new winAPI.secureDesktop.post_secureDesktopStateChange extensionPoint#15392
Merged
Conversation
added 3 commits
September 7, 2023 05:07
…t_secureDesktopStateChange".
…reDesktopStateChange docstring.
See test results for failed build of commit 8851d690a9 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Action,winAPI.secureDesktop.post_secureDesktopStateChange.winAPI.secureDesktopmodule docstring, there was a call tonotify(). AFAIK, the general consumer of this extensionPoint, who registers something to it, shouldn't also be callingnotifyon it. I removed that example line, replacing it with a comment to put the subsequentunregister()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: