Documentation: Add AutosaveMonitor component JSDoc enhancements #60905
Conversation
This file contains 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
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. |
colorful-tones
added
[Type] Developer Documentation
colorful-tones
changed the title
ntsekouras
reviewed
Apr 19, 2024
ntsekouras
reviewed
Apr 19, 2024
ntsekouras
reviewed
Apr 25, 2024
82 tasks
ntsekouras
approved these changes
Apr 26, 2024
huubl
pushed a commit
to huubl/gutenberg
that referenced
this pull request
Apr 26, 2024
…Press#60905) Co-authored-by: colorful-tones <[email protected]> Co-authored-by: ntsekouras <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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?
This is a follow-up to #60882—Adding documentation for the
AutosaveMonitorcomponent. @ntsekouras noted a small change, but it's a good one to merge and consolidate some of the JSDocs.Preview of final, generated editor
READMEis here: https://github.com/colorful-tones/gutenberg/tree/add/autosavemonitor-doc-enhancements/packages/editor#autosavemonitorWhy?
There are a great number of APIs in the editor package that are lacking documentation. We aim to address these 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
AutosaveMonitorcomponent and runnpm run docs:buildto populate theREADMEwith the newly added documents.