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

Readme notes about limitations are confusing. #185

Closed
1 task done
Izhaki opened this issue Sep 11, 2018 · 2 comments
Closed
1 task done

Readme notes about limitations are confusing. #185

Izhaki opened this issue Sep 11, 2018 · 2 comments

Comments

@Izhaki
Copy link
Contributor

Izhaki commented Sep 11, 2018

  • Issue: Documentation
    • Version: Master

README > Limitations / Pitfalls

This is how I read it first time until I decided this makes no sense:

Immer only supports plain objects and arrays.

My thoughts: So no support for strings and integers?
Assumed meaning: It does not support Map and Set (clear in the 1.5.0 README).

For arrays it is assumed only numeric properties (and length) are used.

My thoughts: So arrays cannot contain strings?
Assumed meaning: No idea.

@datenreisender
Copy link

In the same section the

  1. Class instances are not, and will not be supported. Read here more on why that would be a [confusing, conceptual mismatch]

confuses me. It looks like here should be a link and [confusing, conceptual mismatch] looks like it is a draft where the author still wanted to decide, what to actually write.

@mweststrate
Copy link
Collaborator

Clarified the readme on both points, feel free PR further changes if anything is still unclear

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

No branches or pull requests

3 participants