Update PostFormat, PostFormatCheck editor component docs #61732
Conversation
colorful-tones
changed the title
|
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. |
| * <PostFormat /> | ||
| * ``` | ||
| * | ||
| * @returns {React.Element} The rendered PostFormat component. |
There was a problem hiding this comment.
This seems to cause a linter warning. I saw we usually use @return {JSX.Element} or @return {Component}.
| * It filters the post formats based on the supported formats and the current post format. | ||
| * It also provides a suggestion for the post format if it's different from the current post format. | ||
| * | ||
| * @component |
There was a problem hiding this comment.
This seems to cause a linter warning. We should remove the @component.
| @@ -38,6 +38,20 @@ export const POST_FORMATS = [ | |||
| return 0; | |||
| } ); | |||
|
|
|||
| /** | |||
| * `PostFormat` is a React component that provides a dropdown selector for post formats. | |||
There was a problem hiding this comment.
I'd rephrase this a bit to exclude the implementation details (dropdown, fetches etc..) to something like:
... a component that allows changing the post format while also providing a suggestion for the current post.
What? & Why?
Addresses two items in #60358
Adding documentation to existing editor components can help with any of the following:
How?
Add a JSDoc comment to the
PostFormatandPostFormatCheckcomponents and runnpm run docs:buildto populate theREADMEwith the newly added documents.