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

ActorRefExtensions.IsNobody doc says the exact opposite what it does #6313

Closed
aledefault opened this issue Dec 19, 2022 · 1 comment · Fixed by #6334
Closed

ActorRefExtensions.IsNobody doc says the exact opposite what it does #6313

aledefault opened this issue Dec 19, 2022 · 1 comment · Fixed by #6334

Comments

@aledefault
Copy link

Which pages have you looked at?
https://github.com/akkadotnet/akka.net/blob/dev/src/core/Akka/Actor/ActorRef.Extensions.cs

What did these pages not make clear?
ActorRefExtensions.IsNobody logic clearly check if an ActorRef is invalid, but the documentation says the opposite.

An actorRef is thought to be invalid if it's one of the following: null, Nobody and DeadLetterActorRef.
Returns true if the actorRef is valid; otherwise false.

How can we do it better?
Inverting the returns part of the documentation:
Returns true if the actorRef is invalid; otherwise false.

@Aaronontheweb
Copy link
Member

@aledefault yep, you're 100% right - that XML-DOC comment appears to have it backwards.

F0b0s pushed a commit to F0b0s/akka.net that referenced this issue Jan 7, 2023
Aaronontheweb pushed a commit that referenced this issue Jan 7, 2023
Co-authored-by: Sergey Popov <sopopov@ozon.ru>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants