-
Notifications
You must be signed in to change notification settings - Fork 4.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation: Add AutosaveMonitor
component JSDoc and populate README
with auto-gen docs
#60882
Documentation: Add AutosaveMonitor
component JSDoc and populate README
with auto-gen docs
#60882
Conversation
with `npm run docs:build`
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, Damon!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much for the PR and for organizing this effort for WP Engine Contributor Day.
I'm leaving a couple of small comments for future PRs. Sometimes we might already have some JSDoc, but not above the exported component like in this one here.
In this cases we might just copy and/or update these, and move them above the exported module.
@@ -91,6 +91,15 @@ export class AutosaveMonitor extends Component { | |||
} | |||
} | |||
|
|||
/** | |||
* AutosaveMonitor component. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can skip this sentence because the description is generated after the name of the component. This way we don't have duplication of the name.
What?
Adding documentation for
AutosaveMonitor
component. Addresses one item on #60358Aside: I've discussed with @ntsekouras and I would like to utilize #60358 for an upcoming WP Engine Contributor Day, and I'm hoping that if we get a solid PR process then I can create instructions for contributors to replicate my PR process and we can complete the entire Task List of items noted in #60358
Why?
There are a great number of APIs in the editor package that are lacking documentation. We aim to address this one-by-one. See #60358 for a full checklist. This is just the first item on the list 😉
How?
Add a JSDoc comment to the
AutosaveMonitor
component and runnpm run docs:build
to populate theREADME
with the newly added documents.