Skip to content

Document missing PeerOptions fields - #958

Open
ting-hong-shieh wants to merge 1 commit into
cloudflare:mainfrom
ting-hong-shieh:docs/peer-options
Open

Document missing PeerOptions fields#958
ting-hong-shieh wants to merge 1 commit into
cloudflare:mainfrom
ting-hong-shieh:docs/peer-options

Conversation

@ting-hong-shieh

Copy link
Copy Markdown

Summary

  • document read_timeout and write_timeout as per-operation HTTP I/O limits rather than total request limits
  • clarify that idle_timeout starts only after a reusable connection returns to the pool and does not govern active sessions
  • document the HTTP/2 stream limit, extra CONNECT proxy headers, TLS group list, and post-quantum second-key-share option

Testing

  • cargo fmt --all -- --check
  • cargo doc -p pingora-core --no-deps with Rust 1.97.1
  • cargo +1.85.0 doc -p pingora-core --no-deps --offline
  • verified the new text in the rendered PeerOptions rustdoc page

Both rustdoc runs report one existing private-intra-doc-link warning in protocols/http/v2/server.rs; this change adds no warnings.

Closes #302

@ting-hong-shieh
ting-hong-shieh marked this pull request as ready for review August 13, 2026 12:45
@drcaramelsyrup drcaramelsyrup added the documentation Improvements or additions to documentation label Aug 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc] PeerOptions missing field documentation

2 participants