Skip to content

Conversation

@gretchenfrage
Copy link
Collaborator

Aligns with 100 columns, attempts to improve clarity, takes inspiration from tokio::io::AsyncWriteExt docs.

@gretchenfrage gretchenfrage requested review from Ralith and djc as code owners May 10, 2025 18:04
@Ralith
Copy link
Collaborator

Ralith commented May 10, 2025

Initial bikeshedding:

  • Why introduce "resolves to" in addition to "yields"?
  • Why replace "cancel-safe" with "cancellation safe"?

Copy link
Contributor

@flub flub left a comment

Choose a reason for hiding this comment

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

Overall I like these changes!

@flub
Copy link
Contributor

flub commented May 14, 2025

* Why replace "cancel-safe" with "cancellation safe"?

This mirrors how tokio talks about it. They use a section header named Cancel safety and in prose use "This method is cancellation safe".

@djc
Copy link
Member

djc commented Jul 7, 2025

@gretchenfrage want to polish this up so we can merge it?

@gretchenfrage
Copy link
Collaborator Author

@djc Yeah, I'd like to prioritize #2168 personally because I don't like how long I've been blocking it. I haven't lost track of anything, I just haven't had capacity for a while.

@djc
Copy link
Member

djc commented Aug 12, 2025

@djc Yeah, I'd like to prioritize #2168 personally because I don't like how long I've been blocking it. I haven't lost track of anything, I just haven't had capacity for a while.

Would be nice to get this over the finish line.

@gretchenfrage
Copy link
Collaborator Author

My revision of this PR is in-progress, I'm hoping I can put it back into review tomorrow. I appreciate your patience with me as my capacity has been reduced a lot recently.

Aligns with 100 columns, attempts to improve clarity, takes inspiration
from tokio::io::AsyncWriteExt docs.
@gretchenfrage gretchenfrage force-pushed the revise-send-stream-write-docs branch from 185d300 to 8e7240b Compare August 14, 2025 04:53
@gretchenfrage
Copy link
Collaborator Author

  • Rebased over main
  • Changed the first lines of comments to be imperative, for stylistic consistency with rest of project
  • No longer starting first line of docs with "Attempt to" (Tokio sometimes does that but sometimes not. My
    reasoning for removing it is that we don't need to explicitly say that a method which returns a Result
    might fail any more than we need to explicitly say that a method which is async returns a future, at
    least within the first line of the doc comment.)
  • Take flub's suggestion to use Tokio-inspired # Cancel safety headers
  • Slight tweaks / corrections to my own grammar
  • Take Ralith's suggestion to replace phrase "resolves to" with "yields"
  • No longer rearranging order of methods

@gretchenfrage gretchenfrage requested a review from djc August 14, 2025 04:55
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.

Thanks, LGTM.

@gretchenfrage gretchenfrage added this pull request to the merge queue Aug 19, 2025
Merged via the queue into quinn-rs:main with commit ab953ab Aug 19, 2025
20 checks passed
@gretchenfrage gretchenfrage deleted the revise-send-stream-write-docs branch August 19, 2025 23:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants