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

doc: improve package doc and add a note about unbounded task results #30

Merged
merged 1 commit into from
Nov 4, 2021

Conversation

rolinh
Copy link
Member

@rolinh rolinh commented Nov 2, 2021

No description provided.

@rolinh rolinh added area/documentation Improvements or additions to documentation kind/enhancement This would improve or streamline existing functionality. labels Nov 2, 2021
@rolinh rolinh requested review from kaworu and tklauser November 2, 2021 13:27
Copy link
Member

@tklauser tklauser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for documenting this. LGTM with one minor change (probably an accidental paste).

workerpool.go Outdated Show resolved Hide resolved
Signed-off-by: Robin Hahling <robin.hahling@gw-computing.net>
@rolinh rolinh force-pushed the pr/rolinh/improve-doc branch from 117ad0c to bfe9bfe Compare November 2, 2021 13:41
Copy link
Member

@kaworu kaworu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, ditto remarks for the workerpool.go top-level comment section.

README.md Show resolved Hide resolved
One caveat is that while the number of concurrently running workers is limited,
task results are not and they accumulate until they are collected. Therefore,
if a large number of tasks can be expected, the workerpool should be
periodically drained (e.g. every 10k tasks).
Copy link
Member

@kaworu kaworu Nov 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit

Suggested change
periodically drained (e.g. every 10k tasks).
periodically drained (e.g. every ten thousand tasks).

@rolinh rolinh requested a review from kaworu November 3, 2021 10:17
@rolinh rolinh merged commit 780bee2 into master Nov 4, 2021
@rolinh rolinh deleted the pr/rolinh/improve-doc branch November 4, 2021 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation kind/enhancement This would improve or streamline existing functionality.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants