Documentation: Add auto generated API docs for editor package
#60356
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
ntsekouras
added
[Type] Developer Documentation
|
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. |
ntsekouras
force-pushed
the
add/auto-gen-docs-in-editor-package
branch
from
dcbcd8a to
71d04a7
Compare
youknowriad
approved these changes
Apr 2, 2024
|
|
||
| ### AlignmentToolbar | ||
|
|
||
| > **Deprecated** since 5.3, use `wp.blockEditor.AlignmentToolbar` instead. |
There was a problem hiding this comment.
mmm! I expected these to not show up here at all. I wonder how some deprecated APIs don't show up at all in other packages.
Anyway, this is still good enough.
There was a problem hiding this comment.
Maybe we can omit the deprecated file from auto-generated API docs. Those old deprecated components aren't helpful for anyone.
There was a problem hiding this comment.
@Mamaduka Let's explore this separately, as it would require changes for the main docs script. My initial guess would be to add a new custom tag in jsodc to skip, but not sure.
|
Size Change: 0 B Total Size: 1.72 MB ℹ️ View Unchanged
|
82 tasks
cbravobernal
pushed a commit
to garridinsi/gutenberg
that referenced
this pull request
Apr 9, 2024
…Press#60356) Co-authored-by: ntsekouras <[email protected]> Co-authored-by: youknowriad <[email protected]> Co-authored-by: Mamaduka <[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 PR adds auto generated API docs for
editorpackage. I added some deprecated messages to the old re-exported functions/components fromblock-editorpackage.After this PR, I'll create an issue to add docs for exported APIs that are missing them.