Suspicious documentation clause about enable_push - missing negation?

hyperium / h2

HTTP 2.0 client & server implementation for Rust.

MIT License

1.34k stars 269 forks source link

Suspicious documentation clause about enable_push - missing negation? #645

Closed vi closed 1 year ago

vi commented 1 year ago

In client::Builder::enable_push documentation:

pub fn enable_push(&mut self, enabled: bool) -> &mut Self;

This value is included in the initial SETTINGS handshake. When set [?!], the server MUST NOT send a push promise. Setting this value to value to false in the initial SETTINGS handshake guarantees that the remote server will never send a push promise.

Is it meant to be "when set to false"?

seanmonstar commented 1 year ago

I believe you are correct, thanks for catching this. Want to send a PR?