Fix Endpoint.Write documentation#13274
Open
Haihan-Jiang wants to merge 1 commit into
Open
Conversation
Haihan-Jiang
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #6024
Summary
Update the
tcpip.Endpoint.WriteAPI comment so it no longer refers to the removedSlicePayloadcall shape. The ownership guidance still applies, but the example now matches the currentWrite(Payloader, WriteOptions)signature and describes the firstnbytes fetched from the payloader.Testing
git diff --checkbazel test //pkg/tcpip:tcpip_test //pkg/tcpip:tcpip_x_testNote:
go test ./pkg/tcpipwas not used as validation because this repo relies on generated files from the Bazel path; the direct Go command fails before reaching this change with missing generated types such asViewListandwaiterEntry.