Ensure all custom hooks have proper docblocks #470
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
jeffpaul
approved these changes
May 26, 2023
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.
Description of the Change
I noticed that we introduced a few new filters in the last release but those filters did not have proper docblocks. This means they aren't showing within our automated documentation site: https://10up.github.io/classifai/
I did a scan of our codebase and found similar issues with a handful of our existing actions and filters as well, so this PR cleans all of those up. I've also added a link to this doc site at the top of our readmes.
How to test the Change
If desired, you can build the doc site locally by running
npm run build:docsand ensuring all hooks show properly thereChangelog Entry
Credits
Props @dkotter
Checklist: