google/gvisor

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

Open

#6024 aperta il 19 mag 2021

Vedi su GitHub
 (6 commenti) (0 reazioni) (0 assegnatari)Go (1061 fork)batch import
area: networkinggood first issuetype: bug

Metriche repository

Star
 (12.713 star)
Metriche merge PR
 (Merge medio 6g 13h) (156 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Individua il metodo tcpip.Endpoint.Write nel repository gvisor, probabilmente nel pacchetto tcpip. Controlla i commenti dell'issue per eventuali indicazioni sulla firma attuale, quindi aggiorna il commento di documentazione per riflettere il comportamento effettivo. Non ci sono PR collegati, quindi assicurati che la correzione sia coerente con la codebase.
Tech stack
go
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90