cloudflare / cloudflare/pingora

[Doc] PeerOptions missing field documentation

Open
#302 0 comments 1 reaction 0 assignees View on GitHub
documentation
Dominant language
Rust
Stars
27.4k
Forks
1.7k
Avg merge
6h 22m
Merged PRs (30d)
3

Description

## What is the problem your feature solves, or the need it fulfills?

The [PeerOptions](https://docs.rs/pingora/latest/pingora/upstreams/peer/struct.PeerOptions.html) struct defers documentation to the [Peer](https://docs.rs/pingora/latest/pingora/upstreams/peer/trait.Peer.html) trait. The fields of the struct do not match that of the methods of the trait 1:1

Most notably, I am finding that the lack of documentation on idle timeouts to be a bit confusing. I have set the `idle_timeout` to 5 seconds nothing happens after making a connection. No timeout occurs.

If I set `read_timeout` to 5 seconds, after 5 seconds there is a timeout as anticipated.

Request: document `PeerOptions` fields. Notably, document the fields that do not have a corresponding value in the Peer trait.

Fields with no corresponding documentation in trait methods:

- read_timeout
- write_timeout
- no_header_eos
- max_h2_streams
- extra_proxy_headers
- curves
- second_keyshare

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.