use proper example code tag in hooks JSDoc comments #1257
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
|
Deploy preview for react-redux-docs ready! Built with commit 53acb63 |
…ontext` hook to also use @example JSDoc tag
timdorr
pushed a commit
that referenced
this pull request
May 30, 2019
* use proper example code tag in hooks JSDoc comments * fix mistake in `useActions` hook example code * remove TypeScript annotations from example code and adjust `useReduxContext` hook to also use @example JSDoc tag
timdorr
pushed a commit
that referenced
this pull request
Jun 11, 2019
* use proper example code tag in hooks JSDoc comments * fix mistake in `useActions` hook example code * remove TypeScript annotations from example code and adjust `useReduxContext` hook to also use @example JSDoc tag
webguru7
pushed a commit
to webguru7/react-redux
that referenced
this pull request
Dec 8, 2022
* use proper example code tag in hooks JSDoc comments * fix mistake in `useActions` hook example code * remove TypeScript annotations from example code and adjust `useReduxContext` hook to also use @example JSDoc tag
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.
While working on a PR for the TypeScript types the linter use there made me realize I used an invalid syntax for jsdoc example code. This PR fixes the inline comments to use
@example. It also fixes some other minor typos and mistakes in the example code.