mattrobenolt / mattrobenolt/connect-python

Propagate comments to docstrings

Aperta
#13 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Python
Stelle
29
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

The plugin is not propagating docstring from the proto file to the service handler methods.

Related — python plugin with pyi also seems to not propagate comments to docstrings on the types.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia individuando il codice del plugin Python che genera i metodi dei gestori di servizio dai file proto, quindi esamina come vengono rappresentati ed emessi i commenti. Controlla anche il relativo percorso del plugin Python e della generazione dei tipi pyi; il lavoro è completato quando i commenti proto compaiono nelle docstring generate del gestore e del tipo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
tooling
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
38/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.