Skip to content

Improve comment clarity for Subscribe #2855

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.

Sign up for GitHub

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

Open
AdaAibaby wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve comment clarity for Subscribe #2855

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a52f7d
Optimize the comment of Notifier.Subscribe method
adababys May 29, 2026
df4aec3
Merge branch 'main' into chore/improve-subscribe-comment
AdaAibaby May 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/api/internal/sandbox/storage/redis/notifier.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ type Notifier struct {

// Subscribe registers interest in routingKey. The returned channel is
// signaled (non-blocking, drop-on-full) whenever a matching message
// arrives on the shared notify channel. The caller MUST invoke cleanup
// when done to avoid a memory leak.
// arrives on the shared notify channel. The caller MUST invoke the
// returned cleanup function when done to avoid a memory leak.
func (n *Notifier) Subscribe(routingKey string) (<-chan struct{}, func()) {
return n.sub.subscribe(routingKey)
}
Expand Down