Skip to content

Suspicious documentation clause about enable_push - missing negation? #645

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
Closed
vi opened this issue Oct 29, 2022 · 1 comment · Fixed by #646
Closed

Suspicious documentation clause about enable_push - missing negation? #645

vi opened this issue Oct 29, 2022 · 1 comment · Fixed by #646

Comments

@vi
Copy link
Contributor

vi commented Oct 29, 2022

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
Copy link
Member

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

vi added a commit to vi/h2 that referenced this issue Oct 29, 2022
@vi
Fix documentation of enable_push
a5594c4 
Resolves hyperium#645
vi added a commit to vi/h2 that referenced this issue Oct 29, 2022
@vi
Fix docs of enable_push
8e35611 
Remove redundant and misleading phrase in
client::Builder::enable_push documentation.

Resolves hyperium#645
@vi vi mentioned this issue Oct 29, 2022
Merged
seanmonstar pushed a commit that referenced this issue Oct 29, 2022
@vi
Fix docs of enable_push (#646)
294000c 
Remove redundant and misleading phrase in
client::Builder::enable_push documentation.

Resolves #645
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix docs of enable_push vi/h2
2 participants
@seanmonstar @vi