doc: improve doc and examples around task cancellation, drain and callbacks#115
Merged
doc: improve doc and examples around task cancellation, drain and callbacks#115
Conversation
Suggested-by: Alexandre Perrin <alex@isovalent.com> Signed-off-by: Robin Hahling <code@hahling.ch>
Signed-off-by: Robin Hahling <code@hahling.ch>
Signed-off-by: Robin Hahling <code@hahling.ch>
Signed-off-by: Robin Hahling <code@hahling.ch>
Fix e29e14a Signed-off-by: Robin Hahling <code@hahling.ch>
rolinh
added
area/documentation
tklauser
reviewed
Apr 2, 2026
Member
tklauser
left a comment
tklauser
left a comment
There was a problem hiding this comment.
While at it with updating docs, it might make sense to add godoc doc links to some of the exported API to improve navidation on pkg.go.dev.
tklauser
approved these changes
Apr 2, 2026
Member
tklauser
left a comment
tklauser
left a comment
There was a problem hiding this comment.
A few godoc links to internal symbols could also be added to ease navigation, see suggested edits.
Content-wise, the changes look good to me. Thanks a lot for your effort to document this package in so much detail!
rolinh
force-pushed
the
pr/rolinh/doc-updates
branch
from
7de2a88 to
5f5c378
Compare
Suggested-by: Tobias Klauser <tobias@cilium.io> Signed-off-by: Robin Hahling <code@hahling.ch>
rolinh
force-pushed
the
pr/rolinh/doc-updates
branch
from
5f5c378 to
e112510
Compare
Member
Author
|
Good catch! It's interesting that godoclint catches the missing links for std lib references but not for local symbols. Anyways, all addressed now, thanks! |
Member
|
Thanks! I think it's a great addition to use the Submit context in the example! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See commits for details.
Ref: #114 (comment)