This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
Add hook documentation and build script #4927
Merged
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
mikejolley
added
tools
nerrad
requested review from
a team and
nielslange
and removed request for
a team
|
Size Change: 0 B Total Size: 1.23 MB ℹ️ View Unchanged
|
nielslange
approved these changes
Oct 13, 2021
There was a problem hiding this comment.
The PR looks great and works as expected!
I added three minor comments, but feel free to merge this PR, @mikejolley.
mikejolley
force-pushed
the
add/hook-docs
branch
from
f8a5fac to
86e412c
Compare
jonny-bull
pushed a commit
to jonny-bull/woocommerce-gutenberg-products-block
that referenced
this pull request
Dec 14, 2021
* Script to generate hook docs * Inline docs for action and filter hooks * __experimental_woocommerce_blocks_checkout_order_processed example * Update doc generation * Document exceptions * examples * Fix a typo * Remove unused dependency * add platform override for phpunit tests
5 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 PR takes care of:
@examplestag for linking to an MD file with further code examplesUpdating docs consists of running the following command:
Why do this? Because duplicating content between docs and inline is time-consuming and can become out of sync. Having a script can automate this and allows us to document in one place (inline).
Closes #4629
Testing
npm run build:docs. See that docs were generated.