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

fix incorrect documentation of sentPacketHistory.Iterate #2749

Closed
wants to merge 1 commit into from

Conversation

marten-seemann
Copy link
Member

We've been using this in https://github.com/lucas-clemente/quic-go/blob/bed802aee5732c8fe373bf4f71e789bea2f7f11f/internal/ackhandler/sent_packet_handler.go#L158-L166

I thought this was not a safe thing to do, but it turns out to be. Therefore, we can revise the documentation, and add a test case to make sure we don't introduce a regression at some point.

@codecov
Copy link

codecov bot commented Sep 7, 2020

Codecov Report

Merging #2749 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2749   +/-   ##
=======================================
  Coverage   86.52%   86.52%           
=======================================
  Files         128      128           
  Lines        9960     9960           
=======================================
  Hits         8617     8617           
  Misses       1010     1010           
  Partials      333      333           
Impacted Files Coverage Δ
internal/ackhandler/sent_packet_history.go 100.00% <ø> (ø)

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 bed802a...a62618c. Read the comment docs.

@marten-seemann
Copy link
Member Author

Turns out the documentation was right, and the test case I added is wrong. We need to test that we actually iterate over all packets instead.

@marten-seemann marten-seemann deleted the fix-sent-packet-history-iterate-docs branch September 7, 2020 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant