Add JSDoc annotations to the public API #300
Conversation
| * of the Redux store. This is handy for a variety of tasks, such as expressing | ||
| * asynchronous actions in a concise manner, or logging every action payload. | ||
| * | ||
| * See `redux-thunk` package as an example of the Redux middleware. |
There was a problem hiding this comment.
You could use @link here
http://usejsdoc.org/tags-inline-link.html
There was a problem hiding this comment.
Good point. For now I'd avoid hardcoding URL because we might move that package to a separate Github organization soon.
|
I'll get this in, but comments are still very much appreciated. The hardest part to understand is probably |
Add JSDoc annotations to the public API
| * and some part of the state tree may potentially have changed. You may then | ||
| * call `getState()` to read the current state tree inside the callback. | ||
| * | ||
| * @param {Function} listener A callback to be invoked on every dispatch. |
There was a problem hiding this comment.
A good way to document callbacks is to use the @callback tag. This way you can document the @params of the callback function.
There was a problem hiding this comment.
Thanks, I didn't know this! Want to send a PR?
There was a problem hiding this comment.
Sure! I don't really have time tonight though. Guess I can do it after the merge?
Edit: Oh, its merged already ;)
There was a problem hiding this comment.
Yeah feel free to make a PR against breaking-changes-1.0 branch.
This adds JSDoc annotations to the public API as discussed in #140 and #89.
Comments are welcome!
(This is written against the 1.0 API which is not officially released yet.)