golang/go

context: relax recommendation against putting Contexts in structs

Open

#22 602 ouverte le 6 nov. 2017

Voir sur GitHub
 (10 commentaires) (27 réactions) (0 assignés)Go (19 008 forks)batch import
DocumentationNeedsInvestigationhelp wanted

Métriques du dépôt

Stars
 (133 883 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

This is a follow-on from discussion in #14660.

Right now the context package documentation says

Do not store Contexts inside a struct type; instead, pass a Context explicitly to each function that needs it. The Context should be the first parameter, typically named ctx: [...]

This advice seems overly restrictive. @bradfitz wrote in that issue:

While we've told people not to add contexts to structs, I think that guidance is over-aggressive. The real advice is not to store contexts. They should be passed along like parameters. But if the struct is essentially just a parameter, it's okay. I think this concern can be addressed with package-level documentation and examples.

Let's address this concern with package-level documentation.

Also see @rsc's comment at https://github.com/golang/go/issues/14660#issuecomment-200145301.

/cc @Sajmani @bradfitz @rsc

Guide contributeur

Direction de recherche
Cette demande concerne la mise à jour de la documentation du package context en Go (probablement dans src/context/context.go) pour assouplir l'énoncé contre le stockage de Contexts dans des structs. Lisez les commentaires référencés dans #14660, notamment ceux de bradfitz et rsc, pour comprendre les directives nuancées. La modification doit expliquer que stocker un context dans une struct est acceptable lorsque la struct elle même est effectivement un paramètre. Mettez à jour la documentation au niveau du package et ajoutez éventuellement un exemple.
Stack technique
go
Domaine
backend
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.
1-3 heures
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
Go
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70