Skip to content

fixed wrong comment #5462

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

Merged
merged 1 commit into from
Dec 28, 2021
Merged

fixed wrong comment #5462

merged 1 commit into from
Dec 28, 2021

Conversation

brah-mcdude
Copy link
Contributor

@brah-mcdude brah-mcdude commented Dec 28, 2021

The old comment that I previously wrote in ("we are not returning anything") was based on an old variable name that threw me off.
Here is the old code with the old variable name:

                probe.ReceiveWhile<object>(max: max, shouldIgnore: x =>
                {
                    x.Should().NotBeOfType<T>();
                    return false; // we are not returning anything
                });

When I looked into the code of the method ReceiveWhile(), I realized that "shouldIgnore" was a misleading variable name.
So I changed it to "shouldContinue" which much better reflects the code and the docs around it.

But I did not update the comment: "we are not returning anything".

So now, it is time to update the comment as well.
The new comment is: "please continue receiving, don't stop".
Which much better reflects the code and the variable name ("shouldContinue").

@Aaronontheweb Aaronontheweb merged commit fbb580f into akkadotnet:dev Dec 28, 2021
@Aaronontheweb
Copy link
Member

Thanks!

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