feature: allow substituting command_path in command help and epilog text

Aperta
  • Qualcosa non va?
#2,683 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Inizia tracciando la formattazione dell'help del comando e dell'epilogo di Click, quindi confrontala con la sostituzione esistente della stringa di versione %(prog)s descritta nell'issue. Il lavoro è completato quando il testo dell'help e dell'epilogo può sostituire il percorso del comando e il valore della versione, producendo i valori corrispondenti negli esempi di riga di comando mostrati.

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

Descrizione

help output

Given:

@click.command(help="Example: %(prog)s --do-this")
def cli(): pass

Will result in:

$ ./command --help
Example: ./command --do-this
$ python -m command --help
Example: python -m command --do-this

The problem is that it is not possible to template the command from within the help text itself. There is %(prog)s for version string, but not for help or epilog. It would be nice to have them there, also %(version)s.

Thank you, click is great.

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.