You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
This PR adds a JSDoc @example comment to the isPostSavingLocked selector, completing the documentation for the lock and unlock post-saving API.
Why?
The post lock saving API was introduced in PR #10649, which includes the lockPostSaving and unlockPostSaving functions. Both of these functions have comprehensive JSDoc documentation with @example blocks, but the related isPostSavingLocked selector was missing its example documentation.
How?
Added a JSDoc @example block to the isPostSavingLocked selector that demonstrates:
How to use the selector with useSelect hook in a React component
An example showing conditional rendering based on the selector's return value
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.
If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.
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.
What?
Related to: #42125
PR: #10649
This PR adds a JSDoc @example comment to the
isPostSavingLocked
selector, completing the documentation for thelock and unlock post-saving API
.Why?
The post lock saving API was introduced in PR #10649, which includes the lockPostSaving and unlockPostSaving functions. Both of these functions have comprehensive JSDoc documentation with @example blocks, but the related
isPostSavingLocked
selector was missing its example documentation.How?
Added a JSDoc @example block to the isPostSavingLocked selector that demonstrates:
useSelect
hook in a React component