search

montagejs / collections

This package contains JavaScript implementations of common data structures with idiomatic interfaces.
http://www.collectionsjs.com
Other
2.09k stars 185 forks source link

Documentation seems outdated #168

Open madssj opened 7 years ago

madssj commented 7 years ago

Using collections - specifically FastMap I've run into multiple problems with the documentation, which has left me not trusting it.

I've submitted a PR for one such incorrectness (montagejs/collectionsjs.com/pull/45), which has been left without response or action.

Another observed incorrectness is, that new FastMap([[1, 2], [3, 4]]).keys() returns an iterator, even though the documentation insists it returns an array.

I'd be happy to help fix the documentation.

Sunshine168 commented 7 years ago

i cant agree more~ i have the same position in the keys() function , the document is outdating

kriskowal commented 7 years ago

@marchant I recommend adding @madssj as a collaborator.

lmj0011 commented 7 years ago

returns an iterator, even though the documentation insists it returns an array.

This seems to be a common issue

https://github.com/montagejs/collections/issues/161