Add JSDoc to PostVisibility, PostVisibilityCheck, and PostVisibilityLabel #61735
Conversation
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
github-actions
bot
added
the
First-time Contributor
|
👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @dbrian! In case you missed it, we'd love to have you join us in our Slack community. If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information. |
Co-authored-by: dbrian <bgosnell@git.wordpress.org>
| * @param {string} props.label - The label for the visibility option. | ||
| * @param {string} props.info - Additional information about the visibility option. | ||
| * @return {JSX.Element} The rendered component. | ||
| */ |
There was a problem hiding this comment.
This is not exported so we could leave it as is, though it doesn't hurt to have it 😄 .
| @@ -17,6 +17,15 @@ import { __experimentalInspectorPopoverHeader as InspectorPopoverHeader } from ' | |||
| import { visibilityOptions } from './utils'; | |||
| import { store as editorStore } from '../../store'; | |||
|
|
|||
| /** | |||
| * PostVisibility component. | |||
There was a problem hiding this comment.
We need to remove this PostVisibility component. from every component because the generated docs include the component's name, so it's kind of duplicate..
…abel (WordPress#61735) Co-authored-by: dbrian <bgosnell@git.wordpress.org> Co-authored-by: colorful-tones <colorful-tones@git.wordpress.org> Co-authored-by: ntsekouras <ntsekouras@git.wordpress.org>
What?
Part of: #60358
This PR adds JSDoc comments to the PostVisibility, PostVisibilityCheck, and PostVisibilityLabel to improve code documentation and maintainability.