golang/go

x/pkgsite: confusing display of constants block when there are unexported constants

Open

#39 097 ouverte le 15 mai 2020

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)Go (19 008 forks)batch import
DocumentationNeedsInvestigationToolshelp wantedpkgsite

Métriques du dépôt

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

Description

If you look at documentation on this page: https://golang.org/pkg/text/template/parse/#NodeType

The NodeDot is 6 and NodeField is 8, but there is nothing between these two constants. however the source has two unexported consts between NodeDot and NodeField, which makes NodeField 8.

When you debug the code you can easly misunderstand the node types but simply counting them from the top.

The documentation should indicate actual values of constants

Guide contributeur

Direction de recherche
Recherchez comment pkgsite affiche les blocs de constantes et modifiez le rendu pour afficher les valeurs réelles ou indiquer les lacunes causées par les constantes non exportées.
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.
2
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.
Ancienne
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.
80