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

Improve documentation example for DispatchManagingActor #56

Open
llucax opened this issue Sep 24, 2024 · 0 comments
Open

Improve documentation example for DispatchManagingActor #56

llucax opened this issue Sep 24, 2024 · 0 comments
Labels
part:docs Affects the documentation type:enhancement New feature or enhancement visitble to users

Comments

@llucax
Copy link
Contributor

llucax commented Sep 24, 2024

The DispatchManagingActor example in the class docs should do something else than just listening to updates.

Maybe it is worth adding some other logic to represent that, maybe implement a ClockActor that ticks every X time, where X is a dispatch option? So we have a select() instead with a timer (printing the time) and the updates_channel.

The example should also clearly show that the managed actor's _run() method should first receive from the updates channel, otherwise it might miss the initial setup of the dispatch. This should also probably be mentioned more explicitly in the docs themselves, not just the example.

I even wonder if we should somehow enforce this, requiring a special start() method for managed actors or something like that.

Originally posted by @llucax in:

@llucax llucax added part:docs Affects the documentation type:enhancement New feature or enhancement visitble to users labels Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:docs Affects the documentation type:enhancement New feature or enhancement visitble to users
Projects
None yet
Development

No branches or pull requests

1 participant