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

docs(roundrobinlist.js): fix usage #402

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

743v45
Copy link
Contributor

@743v45 743v45 commented Apr 24, 2023

push() returns the new length

const RRL = require('./lib/roundrobinlist');

const list = new RRL([1, 2, 3]);

console.log(list.next());
console.log(list.next(2));
console.log(list.next(2));
console.log(list.add(5));
console.log(list.next(2));

// [ 1 ]
// [ 2, 3 ]
// [ 1, 2 ]
// 4
// [ 3, 5 ]

push() returns the new length
@@ -7,7 +7,7 @@
* list.next() ==> [1]
* list.next(2) ==> [2, 3]
* list.next(2) ==> [1, 2]
* list.add(5) ==> 5
* list.add(5) ==> 4
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add returns the item added, not the length of the list.

* @return {*} The item added.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but add return push() not item.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. The return value isn't used anywhere. That said, I think we should match the docstring instead of the current behavior.

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

Successfully merging this pull request may close these issues.

2 participants