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

Documentation: Appears to be some copy pasta in FSM.SubscribeTransitionCallback class docs #5090

Open
mchandschuh opened this issue Jun 14, 2021 · 1 comment

Comments

@mchandschuh
Copy link
Contributor

Apologies for not following the template, but it didn't really apply.

The class level documentation on FSMBase.SubscribeTransitionCallback doesn't make sense. It looks like the author copied the wrong type names in a couple of places.

See: https://github.com/akkadotnet/akka.net/blob/dev/src/core/Akka/Actor/FSM.cs#L157

/// <summary>
/// Send this to an <see cref="SubscribeTransitionCallBack"/> to request first the <see cref="UnsubscribeTransitionCallBack"/>
/// followed by a series of <see cref="Transition{TS}"/> updates. Cancel the subscription using
/// <see cref="CurrentState{TS}"/>.
/// </summary>
public sealed class SubscribeTransitionCallBack
  • Send this to an SubscribeTransiitionCallback should probably be to an FSM
  • ...to request first the UnsubscribeTransitionCallback - not sure what this is trying to tell me
  • Cancel the subscription using CurrentState<TS> - unsubscribe using UnsubscribeTransitionCallback
@Aaronontheweb
Copy link
Member

Yeah this doesn't seem right....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants