Skip to content

docs(roundrobinlist.js): fix usage - #402

Open
743v45 wants to merge 1 commit into
dudleycarr:mainfrom
743v45:patch-1
Open

743v45 wants to merge 1 commit into
dudleycarr:mainfrom
743v45:patch-1

Conversation

@743v45

@743v45 743v45 commented Apr 24, 2023 •

Copy link
Copy Markdown
Contributor

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
Comment thread lib/roundrobinlist.js
* list.next(2) ==> [2, 3]
* list.next(2) ==> [1, 2]
* list.add(5) ==> 5
* list.add(5) ==> 4

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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.

This branch has not been deployed

No deployments
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