google/gvisor

tcpip.Endpoint.Write() doc is out of date

Open

#6,024 opened on 2021年5月19日

GitHub で見る
 (6 comments) (0 reactions) (0 assignees)Go (12,713 stars) (1,061 forks)batch import
area: networkinggood first issuetype: bug

説明

The doc says

	// Unlike io.Writer.Write, Endpoint.Write transfers ownership of any bytes
	// successfully written to the Endpoint. That is, if a call to
	// Write(SlicePayload{data}) returns (n, err), it may retain data[:n], and
	// the caller should not use data[:n] after Write returns.

but the signature of Write has since changed. It no longer accepts a slice payload, so this advice is no longer applicable.

コントリビューターガイド

技術スタック
go
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Go programming
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90
調査方針
Locate the tcpip.Endpoint.Write method in the gvisor repository, likely in the tcpip package. Check the issue comments for any direction on the current signature, then update the doc comment to match the actual behavior. No linked PRs, so ensure the fix is consistent with the codebase.