Skip to content
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.

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

Improve documentation on timeouts #249

Merged
merged 2 commits into from
Nov 10, 2020
Merged

Improve documentation on timeouts #249

merged 2 commits into from
Nov 10, 2020

Conversation

sagebind
Copy link
Owner

How timeouts are applied was a bit vague in our documentation and was causing some confusion. Add more detail to make it hopefully more clear as to what the timeout does, in particular that the timeout is still active even once the response headers are received and while the body has not been yet read.

@sagebind sagebind added the documentation Documentation changes label Nov 10, 2020
@codecov
Copy link

codecov bot commented Nov 10, 2020

Codecov Report

Merging #249 (b3213be) into master (f0b5ba9) will increase coverage by 0.05%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #249      +/-   ##
==========================================
+ Coverage   72.24%   72.30%   +0.05%     
==========================================
  Files          48       48              
  Lines        2425     2423       -2     
==========================================
  Hits         1752     1752              
+ Misses        673      671       -2     
Impacted Files Coverage Δ
src/config/mod.rs 60.71% <ø> (ø)
tests/timeouts.rs 100.00% <100.00%> (+12.50%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f0b5ba9...b3213be. Read the comment docs.

@sagebind sagebind merged commit 11bc004 into master Nov 10, 2020
@sagebind sagebind deleted the more-timeouts branch November 10, 2020 02:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant