Skip to content

Explain the Receiver.close() method in the user guide #368

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
Merged
merged 1 commit into from
Jan 27, 2025
Merged

Explain the Receiver.close() method in the user guide #368

merged 1 commit into from
Jan 27, 2025

Conversation

@shsms
Copy link
Contributor

@shsms shsms commented Jan 21, 2025

No description provided.

@shsms shsms requested a review from a team as a code owner January 21, 2025 12:36
@shsms shsms requested a review from Marenz January 21, 2025 12:36
@github-actions github-actions bot added the part:core Affects the core types (`Sender`, `Receiver`, exceptions, etc.) label Jan 21, 2025
@shsms shsms added the cmd:skip-release-notes It is not necessary to update release notes for this PR label Jan 21, 2025
@shsms shsms mentioned this pull request Jan 21, 2025
Merged
@llucax llucax added this to the v1.6.1 milestone Jan 21, 2025
llucax
llucax previously approved these changes Jan 21, 2025
View reviewed changes
@llucax
Copy link
Contributor

llucax commented Jan 21, 2025 •
edited
Loading

Maybe add a more explicit mention about cleanup too (it sounds a bit too optional IMHO). Maybe making a parallel with files or sockets?

@shsms
Copy link
Contributor Author

shsms commented Jan 22, 2025

I've added a fixup commit. Does that look better?

llucax
llucax approved these changes Jan 22, 2025
View reviewed changes
Copy link
Contributor

@llucax llucax left a comment

Choose a reason for hiding this comment

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

Yup, LGTM. We can also use with closing(recv) 🤩

@shsms shsms added this pull request to the merge queue Jan 24, 2025
@shsms shsms removed this pull request from the merge queue due to a manual request Jan 24, 2025
@shsms
Copy link
Contributor Author

shsms commented Jan 24, 2025

Oops, need to squash

@shsms shsms force-pushed the closing-receiver-docs branch from 569985c to b5fee0b Compare January 27, 2025 13:24
@shsms
Copy link
Contributor Author

shsms commented Jan 27, 2025

Squashed.

@shsms shsms enabled auto-merge January 27, 2025 13:24
@shsms shsms added this pull request to the merge queue Jan 27, 2025
Merged via the queue into frequenz-floss:v1.x.x with commit ccef0ab Jan 27, 2025
14 checks passed
@shsms shsms deleted the closing-receiver-docs branch January 27, 2025 13:34
@shsms shsms linked an issue Mar 7, 2025 that may be closed by this pull request
A way to explicitly stop a Receiver #297
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@llucax llucax llucax approved these changes

@Marenz Marenz Awaiting requested review from Marenz Marenz is a code owner automatically assigned from frequenz-floss/python-sdk-team

Assignees

No one assigned

Labels

cmd:skip-release-notes It is not necessary to update release notes for this PR part:core Affects the core types (`Sender`, `Receiver`, exceptions, etc.)

Projects

None yet

Milestone

v1.6.1

Development

Successfully merging this pull request may close these issues.

A way to explicitly stop a Receiver

2 participants

@shsms @llucax