Core Data: Add docgen auto-documentation for actions, selectors #15200
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
aduth
added
[Type] Developer Documentation
aduth
requested review from
ajitbohra,
gziolo,
nerrad,
noisysocks,
ntwb and
youknowriad
as code owners
This was referenced Apr 25, 2019
This was referenced Apr 29, 2019
oandregal
pushed a commit
that referenced
this pull request
May 16, 2019
This PR does two things: - Fixes #15626 and #15680 by making the script synchronous. In #15200 we missed the fact that to fill tokens within the same file we need to execute docgen synchronously, otherwise, the last token process will overwrite the first. - Updates our espree dependency to 4.0.0. When error reporting was back, we uncovered that introducing short Fragment syntax in #15120 caused docgen to fail. The reason is that the espree version we used didn't support that. This fixes it by upgrading it to one that does. A couple of restrictions: - espree uses acorn-jsx to power JSX parsing. - acorn-jsx@4.1.0 added support for JSX fragment short syntax (patched in 4.1.1). - espree@4.0.0 added acorn-jsx@4.1.1. We should use this at a minimum. - espree@4.1.0 added acorn@6 and acorn-jsx@5 for parsing. This caused an error I couldn't identify the source. - espree@5.0.0 removed support for the attachComment. We use this for collocating the JSDoc comment with the proper export statement. Without this, we can't migrate to espree@5.0.0.
This was referenced Sep 12, 2024
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.
This pull request seeks to update the docgen auto-documentation script to generate documentation for actions and selectors of the
@wordpress/core-datamodule.Implementation notes:
I could see this being iterated upon toward:
docs/toolscript in favor of consolidating all data documentation herereturnstateargumentcore-dataselectorscoreentities (getEntityRecords, etc) #12120Testing Instructions:
Verify there are no local changes after running
npm run docs:buildin this branch.