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(entity): Call setAll instead of deprecated addAll #2484

Merged

Conversation

keenanamigos
Copy link
Contributor

It is indicated in the documentation that addAll has been deprecated in favor of setAll. In the reducer switch/case example, addAll was still being used instead of setAll.

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 #

What is the new behavior?

No behavioral changes as this fix only affects documentation.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

It is indicated in the documentation that addAll has been deprecated in favor of setAll. In the reducer switch/case example, addAll was still being used instead of setAll.
@ngrxbot
Copy link
Collaborator

ngrxbot commented Apr 10, 2020

Preview docs changes for 6b1eadd at https://previews.ngrx.io/pr2484-6b1eadd/

@brandonroberts
Copy link
Member

Thanks for the PR @keenanamigos! The file you should edit is here https://github.com/ngrx/platform/blob/master/projects/ngrx.io/content/guide/entity/adapter.md

Those docs are the older versions that will be deleted soon.

@brandonroberts brandonroberts self-assigned this Apr 10, 2020
@brandonroberts brandonroberts added the Needs Cleanup Review changes needed label Apr 10, 2020
@keenanamigos
Copy link
Contributor Author

keenanamigos commented Apr 10, 2020

Thanks for the PR @keenanamigos! The file you should edit is here https://github.com/ngrx/platform/blob/master/projects/ngrx.io/content/guide/entity/adapter.md

Those docs are the older versions that will be deleted soon.

Ah, my mistake. Thanks for letting me know! I will make that change.

…documentation

This commit reverts the change to the old documentation and updates the new documentation with a call to setAll instead of addAll
@brandonroberts
Copy link
Member

@keenanamigos will you make one more change, and change the addAll in the list of adapter collections methods to setAll? Thanks!

@brandonroberts brandonroberts merged commit c210572 into ngrx:master Apr 18, 2020
@brandonroberts
Copy link
Member

Thanks @keenanamigos! If you see anything else, feel free to open a new PR.

@keenanamigos
Copy link
Contributor Author

Thanks @keenanamigos! If you see anything else, feel free to open a new PR.

Thanks a ton @brandonroberts! Sorry for the delay--I can still fix the other piece of documentation re: addAll and setAll if you want?

@brandonroberts
Copy link
Member

Sure. No rush

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Cleanup Review changes needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants