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.

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

Jump to bottom

Improve SubscribableListener's class level comment #103833

Closed
DiannaHohensee opened this issue Jan 2, 2024 · 1 comment · Fixed by #110209
Closed

Improve SubscribableListener's class level comment #103833

DiannaHohensee opened this issue Jan 2, 2024 · 1 comment · Fixed by #110209
Assignees
@ankikuma
Labels
:Distributed/Network Http and internode communication implementations >non-issue Team:Distributed Meta label for distributed team

Comments

@DiannaHohensee
Copy link
Contributor

DiannaHohensee commented Jan 2, 2024 •
edited
Loading

SubscribableListener's class level comment should include that once it is complete, #addListener will immediately set the result on any new subscribers. This is a very important feature of the class in order to use it properly in concurrent environments, but the important documentation is hidden on the #addListener method.
@DiannaHohensee DiannaHohensee added >non-issue :Distributed/Network Http and internode communication implementations Team:Distributed Meta label for distributed team labels Jan 2, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

@ankikuma ankikuma linked a pull request Jun 26, 2024 that will close this issue
Enhance comments for SubscribableListener #110209
Merged
@ankikuma ankikuma mentioned this issue Jun 27, 2024
Merged
ankikuma added a commit that referenced this issue Jun 27, 2024
@ankikuma
Enhance comments for SubscribableListener (#110209)
ae5c767 
This PR enhances class level comments for the SubscribableListener class.

Fixes issue #103833.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ankikuma ankikuma

Labels
:Distributed/Network Http and internode communication implementations >non-issue Team:Distributed Meta label for distributed team
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Enhance comments for SubscribableListener ankikuma/elasticsearch
3 participants
@DiannaHohensee @elasticsearchmachine @ankikuma