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.

Sign up for GitHub

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
Open

docs(roundrobinlist.js): fix usage #402

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/roundrobinlist.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

nsqjs/lib/roundrobinlist.js

Line 37 in 457b2d5

* @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.

* list.next(2) ==> [3, 5]
*/
class RoundRobinList {
Expand Down