close
Skip to content

Documentation: Add isPostSavingLocked example to doc block#70370

Merged
t-hamano merged 1 commit intoWordPress:trunkfrom
Infinite-Null:docs/isPostSavingLocked-example
Jun 11, 2025
Merged

Documentation: Add isPostSavingLocked example to doc block#70370
t-hamano merged 1 commit intoWordPress:trunkfrom
Infinite-Null:docs/isPostSavingLocked-example

Conversation

@Infinite-Null
Copy link
Contributor

@Infinite-Null Infinite-Null commented Jun 10, 2025

What?

Related to: #42125
PR: #10649

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

@github-actions
Copy link

github-actions bot commented Jun 10, 2025

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.

Co-authored-by: Infinite-Null <ankitkumarshah@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@t-hamano t-hamano added [Type] Developer Documentation Documentation for developers [Package] Editor /packages/editor labels Jun 11, 2025
Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

Good example 👍

@t-hamano t-hamano added the props-bot Manually triggers Props Bot to ensure the list of props is up to date. label Jun 11, 2025
@github-actions github-actions bot removed the props-bot Manually triggers Props Bot to ensure the list of props is up to date. label Jun 11, 2025
@t-hamano t-hamano merged commit 2395013 into WordPress:trunk Jun 11, 2025
79 of 84 checks passed
@github-actions github-actions bot added this to the Gutenberg 21.1 milestone Jun 11, 2025
@talldan talldan changed the title Add example doc comment Documentation: Add isPostSavingLocked example to doc block Jun 25, 2025
chriszarate pushed a commit to chriszarate/gutenberg that referenced this pull request Jul 1, 2025
…70370)

Co-authored-by: Infinite-Null <ankitkumarshah@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Package] Editor /packages/editor [Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants