Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: API level documentation for Creator Functions #1977

Closed
jtcrowson opened this issue Jun 27, 2019 · 0 comments · Fixed by #1980
Closed

docs: API level documentation for Creator Functions #1977

jtcrowson opened this issue Jun 27, 2019 · 0 comments · Fixed by #1980

Comments

@jtcrowson
Copy link
Contributor

I'd like to help NgRx achieve better API level documentation, similar to angular.io/api.

I'd like to submit a PR to create JSDocs for createAction, createReducer, and createEffect.

This would be a good place to put implementation details, like for createReducer, the fact that only 10 actions can be provided per on, and duplicated action type handling (#1956).

If accepted, I would be willing to submit a PR for this feature

[x] Yes (Assistance is provided if you need help submitting a pull request)
[ ] No

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants