Document help page generation for maintainers

Aperta
#3,094 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

  • #3326 di @gdesai23 — chiusa senza merge

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
cli, documentation

Direzione di ricerca

Traccia il percorso di generazione delle pagine di aiuto attraverso il codice di Click, usando un debugger come suggerito nell’issue. Documenta la sequenza esatta e i punti di ingresso, in modo che i maintainer condividano una comprensione chiara di come vengono generate le pagine di aiuto.

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

Descrizione

help output

After reading the code, it is not clear to me how exactly help pages are generated. Before any changes can be considered, we should have a shared understanding of the exact path for generating help pages.

At some point, I will play around in a debugger and work this out. If anyone knows, feel free to chime in.

Lingua principale
Python
Stelle
17.8k
Fork
3.3k
Merge medio
3g 3h
PR unite (30g)
13

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

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.

Altre issue di pallets/click

Tutte le issue di pallets/click

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.