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 typo related to change listeners #193

Open limikael opened 6 years ago

limikael commented 6 years ago

In the doc it says:

Each of these changes can be communicated with a single message, (plus, minus, index): the values removed after that index, then the values that were added after that index, and the index, in that order.

The names of the parameters are plus and minus, so the first one is the added values, the second one is the removed values. I also double checked with a test, and the added values are sent as the first parameter, the removed as the second. So I think this should be:

Each of these changes can be communicated with a single message, (plus, minus, index): the values added after that index, then the values that were removed after that index, and the index, in that order.

hthetiot commented 6 years ago

Please make PR.

limikael commented 6 years ago

Oh... It was a long time ago since I interacted with this project, and it was only for a very brief amount of time... Can you please point me in the direction of where the documentation is again, and I'll be happy to make the update... Sorry about that... If it is not worth the effort for you, just close the issue...