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.

Sign up for GitHub

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

Jump to bottom

docs: API level documentation for Creator Functions #1980

Merged
merged 12 commits into from
Jul 7, 2019
Merged

docs: API level documentation for Creator Functions #1980

merged 12 commits into from
Jul 7, 2019

Conversation

jtcrowson
Copy link
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Closes #1977, #1956

What is the new behavior?

  • Creates basic API documentation for Creator Functions.
  • Does not attempt to provide the level of context that the main documentation provides.
  • Provides simple usage examples.
  • Provides implementation details.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

@ngrxbot
Copy link
Collaborator

ngrxbot commented Jun 27, 2019

Preview docs changes for 81d1c3e at https://previews.ngrx.io/pr1980-81d1c3e/

timdeschryver
timdeschryver reviewed Jun 30, 2019
View reviewed changes
Copy link
Member

@timdeschryver timdeschryver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great 👍!
I left some minor notes.

modules/effects/src/models.ts Show resolved Hide resolved
modules/effects/src/models.ts Outdated Show resolved Hide resolved
modules/store/src/action_creator.ts Outdated Show resolved Hide resolved
modules/store/src/action_creator.ts Show resolved Hide resolved
modules/store/src/action_creator.ts Show resolved Hide resolved
modules/store/src/reducer_creator.ts Show resolved Hide resolved
@ngrxbot
Copy link
Collaborator

ngrxbot commented Jul 1, 2019

Preview docs changes for 255258d at https://previews.ngrx.io/pr1980-255258d/

@ngrxbot
Copy link
Collaborator

ngrxbot commented Jul 1, 2019

Preview docs changes for 10973f0 at https://previews.ngrx.io/pr1980-10973f0/

1 similar comment
@ngrxbot
Copy link
Collaborator

ngrxbot commented Jul 1, 2019

Preview docs changes for 10973f0 at https://previews.ngrx.io/pr1980-10973f0/

@ngrxbot
Copy link
Collaborator

ngrxbot commented Jul 1, 2019

Preview docs changes for dfbeafc at https://previews.ngrx.io/pr1980-dfbeafc/

@timdeschryver timdeschryver mentioned this pull request Jul 2, 2019
Merged
3 tasks
brandonroberts
brandonroberts requested changes Jul 5, 2019
View reviewed changes
modules/effects/src/index.ts Show resolved Hide resolved
modules/effects/src/effect_creator.ts Outdated Show resolved Hide resolved
modules/store/src/reducer_creator.ts Outdated Show resolved Hide resolved
@ngrxbot
Copy link
Collaborator

ngrxbot commented Jul 7, 2019

Preview docs changes for 70fcd4d at https://previews.ngrx.io/pr1980-70fcd4d/

@brandonroberts brandonroberts merged commit 3c18263 into ngrx:master Jul 7, 2019
@jtcrowson jtcrowson mentioned this pull request Jul 15, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timdeschryver timdeschryver timdeschryver left review comments

@brandonroberts brandonroberts brandonroberts approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: API level documentation for Creator Functions
4 participants
@jtcrowson @ngrxbot @brandonroberts @timdeschryver