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

Update Connection::close docs for new API #1924

Merged
merged 1 commit into from
Aug 9, 2024
Merged

Update Connection::close docs for new API #1924

merged 1 commit into from
Aug 9, 2024

Conversation

flub
Copy link
Contributor

@flub flub commented Jul 19, 2024

In the new API the finish call no longer returns a future and to achieve the same behaviour the future from stopped needs to be used.

Ralith
Ralith requested changes Jul 19, 2024
View reviewed changes
quinn/src/connection.rs Outdated Show resolved Hide resolved
@flub flub force-pushed the flub/conn-close-docs branch from 1e4026e to f457890 Compare July 29, 2024 11:04
@flub flub requested a review from Ralith July 29, 2024 11:05
@flub
Copy link
Contributor Author

flub commented Aug 6, 2024

Any comments on the updated text in the PR? Is this the right track, does it need further tweaking?

Ralith
Ralith requested changes Aug 6, 2024
View reviewed changes
Copy link
Collaborator

@Ralith Ralith left a comment

Choose a reason for hiding this comment

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

Looks good overall! Some editorial nits, and I think you forgot to rework the Connection docs after our discussion.

quinn/src/connection.rs Outdated Show resolved Hide resolved
quinn/src/connection.rs Outdated Show resolved Hide resolved
quinn/src/connection.rs Outdated Show resolved Hide resolved
quinn/src/connection.rs Outdated Show resolved Hide resolved
quinn/src/connection.rs Outdated Show resolved Hide resolved
quinn/src/connection.rs Outdated Show resolved Hide resolved
quinn/src/connection.rs Outdated Show resolved Hide resolved
@flub
Copy link
Contributor Author

flub commented Aug 8, 2024

Looks good overall! Some editorial nits, and I think you forgot to rework the Connection docs after our discussion.

Could you be more specific? I did add a paragraph under Connection that summarises and refers to Connection::close. Were we going to write more here? Or do you mean somewhere else?

@flub flub requested a review from Ralith August 8, 2024 09:43
@Ralith
Copy link
Collaborator

Ralith commented Aug 8, 2024

Could you be more specific?

Just the stuff you fixed in your latest commit. Thanks!

Ralith
Ralith approved these changes Aug 8, 2024
View reviewed changes
Copy link
Collaborator

@Ralith Ralith left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for working through this with us! I think this will be a big help to clarify good patterns for users going forwards, and save us all time in explaining the subtleties.

@flub
Update Connection::close docs for better guidance
417cc7c 
The existing docs were no longer correct and also the suggested
approach is still error prone.  This describes the intricasies of
closing a QUIC connection a bit more.
@flub flub force-pushed the flub/conn-close-docs branch from 25fc06f to 417cc7c Compare August 9, 2024 08:26
@flub
Copy link
Contributor Author

flub commented Aug 9, 2024

squashed into a single commit

djc
djc approved these changes Aug 9, 2024
View reviewed changes
Copy link
Member

@djc djc left a comment

Choose a reason for hiding this comment

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

This is looking great, thanks for all the efforts!

@djc djc added this pull request to the merge queue Aug 9, 2024
Merged via the queue into quinn-rs:main with commit c0b1e28 Aug 9, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@djc djc djc approved these changes

@Ralith Ralith Ralith approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@flub @Ralith @djc