cockroachdb/cockroach

docgen: recognize "unimplemented" as marker to ignore rules

Ouverte

#45 464 ouverte le 26 févr. 2020

Voir sur GitHubGuide contributeur
 (7 commentaires) (0 réaction) (0 personne assignée)Go (4 124 forks)batch import
A-docsC-enhancementE-easygood first issue

Métriques du dépôt

Stars
 (32 150 étoiles)
Métriques de merge PR
 (Merge moyen 5j 4h) (26 PRs mergées en 30 j)

Description

Various aspects of our SQL grammar are marked as "unimplemented". These unimplemented features/keywords/etc. should not be included in the generated SQL diagrams we use in our docs. Currently, we must edit diagrams.go to hide unimplemented syntax from the generated bnfs that are used to genereate our SQL diagrams. Instead, it would be great if "unimplemented" were treated like /* SKIP DOC */. This would be much more efficient in that all unimplemented features would be excluded from all generated bnfs without docs writers needed to tweak diagrams.go.

Example: https://github.com/cockroachdb/cockroach/pull/45442

Jira issue: CRDB-5153

Guide contributeur

Direction de recherche
Examinez le fichier `diagrams.go` et la gestion existante du marqueur `/* SKIP DOC */` dans l'outil docgen. Implémentez la logique pour également reconnaître "unimplemented" comme marqueur afin d'exclure les règles des BNF générées.
Stack technique
go
Domaine
documentation
Type d'issue
Fonctionnalité
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.
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