alecthomas / alecthomas/kingpin

Documentation of public methods on private structs is hidden

Aperta
#311 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Go
Stelle
3.6k
Fork
279
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

It seems like a lot of the API documentation is not visible on go.dev or godoc.org because of the fact that these methods belong to private structs used as mixins into public structs.

So for example the `*Application` returned by `kingpin.New` has a `Flag` method provided by its embedded `cmdMixin`, which in turn embeds a `*flagGroup`. But this method is entirely missing from the API docs because `flagGroup` is private.

I don't know that this is easily fixable in v2 but it'd be really nice to fix this in v3.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.