Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Documentation Nomenclature #983
Same problem. It looks like C++/Boost. It's just not expected for a dynamically typed language and it makes it harder to parse. In some (most?) cases i have not the slightest idea what is meant, and there are few usecases or examples. I wish it would be documented as virtually all other js projects are, like lodash, etc. I really wonder, why was this even necessary?
The documentation function types are written in typescript to help explain how various methods work.
Some but not all documentation contains examples. If you wish, adding examples and improving documentation is an excellent way to contribute back to open source software.
All documentation for this library is automatically generated from https://github.com/facebook/immutable-js/blob/master/type-definitions/Immutable.d.ts which should make contributions easier