google/gvisor

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

Open

#6.024 geöffnet am 19. Mai 2021

Auf GitHub ansehen
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (1.061 Forks)batch import
area: networkinggood first issuetype: bug

Repository-Metriken

Stars
 (12.713 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 4T 22h) (184 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Suchen Sie die Methode tcpip.Endpoint.Write im gvisor Repository, wahrscheinlich im tcpip Paket. Überprüfen Sie die Issue Kommentare auf Hinweise zur aktuellen Signatur und aktualisieren Sie dann den Dokumentationskommentar, um dem tatsächlichen Verhalten zu entsprechen. Es gibt keine verknüpften PRs, stellen Sie also sicher, dass die Korrektur mit der Codebasis konsistent ist.
Tech Stack
go
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90