omniscientjs / immstruct

Immutable data structures with history for top-to-bottom properties in component based libraries like React. Based on Immutable.js
374 stars 21 forks source link

immstruct.get examples broken on API page #75

Closed kswope closed 9 years ago

kswope commented 9 years ago

https://github.com/omniscientjs/immstruct/blob/master/api.md

Seems like change is happening too fast for the docs, all the examples regarding immstruct.get() are broken. Doesn't look like there's an immstruct.get.

To make matters worse there is nothing regarding cursor.get, only cursor.set and cursor.update. Much confusion.

mikaelbr commented 9 years ago

Hi!

Seems like change is happening too fast for the docs, all the examples regarding immstruct.get() are broken. Doesn't look like there's an immstruct.get.

Right now, the docs show the documentation for the current released version (v1.4.1), so it might be confusing to see the current master branch. That being said, both the master and v1.4.1 does still have a immstruct.get, method. For the current stable (v1.4.1), see L12-L17 and L56-L60. This is a method for getting defined instances on a immstruct object.

To make matters worse there is nothing regarding cursor.get, only cursor.set and cursor.update. Much confusion.

There is no extensive documentation for the cursors them self, as they are actually Immutable.js code. This should be more clear in the documentation, but you can find it's API definition in the Immutable.js repo.