google/gvisor

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

Open

#6 024 ouverte le 19 mai 2021

Voir sur GitHub
 (6 commentaires) (0 réactions) (0 assignés)Go (1 061 forks)batch import
area: networkinggood first issuetype: bug

Métriques du dépôt

Stars
 (12 713 stars)
Métriques de merge PR
 (Merge moyen 4j 22h) (184 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Localisez la méthode tcpip.Endpoint.Write dans le dépôt gvisor, probablement dans le package tcpip. Vérifiez les commentaires de l'issue pour toute indication sur la signature actuelle, puis mettez à jour le commentaire de documentation pour qu'il corresponde au comportement réel. Aucune PR liée, assurez vous donc que la correction soit cohérente avec la base de code.
Stack technique
go
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90