search

akkadotnet / akka.net

Canonical actor model implementation for .NET with local + distributed actors in C# and F#.
http://getakka.net
Other
4.69k stars 1.04k forks source link

Docs: missing BackoffSupervisor.PropsWithSupervisorStrategy documentation #5065

Open christallire opened 3 years ago

christallire commented 3 years ago

Please describe what you are trying to understand BackoffSupervisor.PropsWithSupervisorStrategy

What did these pages not make clear? BackoffSupervisor.PropsWithSupervisorStrategy has no documentation or very basic documentation in XML doc, I'm not sure how it works

How can we do it better? add more details

Additional suggestions first I thought BackoffSupervisor.PropsWithSupervisorStrategy is the shorthand of BackoffSupervisor.Props(Backoff.OnFailure(...)) but it appears not. it behaves differently, could we have a more detailed explanation about it?

ismaelhamed commented 3 years ago

Not sure if there's much more that can be added to method description since it does exactly what is says: creates the props for an BackoffSupervisor actor with a custom supervision strategy, unlike BackoffSupervisor.Props(Backoff.OnFailure(...)) and BackoffSupervisor.Props(Backoff.OnStop(...)) that use the two built-in supervision strategies.

christallire commented 3 years ago

Yeah, this might be silly but hard to know as a newbie -- just wanted to share the experience.