Qual è la differenza tra una pagina man e --help per uno script Python?

Question

Qual è la differenza tra una pagina man e --help per uno script Python?

#1 da (7 voti)

2

Attualmente sto sviluppando alcune procedure operative standard per la società per cui lavoro. Sto iniziando con gli esempi molto piccoli; come script. Attualmente ci sono diversi script scritti in diverse lingue. L'idea è di attenersi alle migliori pratiche di ciascuna lingua per lo sviluppo di uno strumento. Il vero problema per il business è che il modo in cui utilizzare uno script e il modo in cui viene usato lo script viene passato di bocca in bocca.

Pertanto, per ciascun repository, fornirò un SOP per:

Manuale dell'utente
Pratiche di codifica.
Best practice del controllo della versione.
Documentazione di aiuto

A partire da # 4 So che in Python è possibile sviluppare uno script con docstring di aiuto incorporato nel codice. Mi stavo chiedendo allora; qual è la differenza tra questo approccio e le pagine man effettive?

La maggior parte degli sviluppatori qui lavora su Windows.

In termini di best practice dovrebbero essere richiesti entrambi gli approcci o solo la documentazione Python --help integrata

python documentation

posta Coding hierarchy 02.10.2017 - 15:35

fonte

1 risposta

Leggi altre domande sui tag python documentation

Distingue tra le variabili utilizzate e non utilizzate nelle proprietà Memorizza e etichetta milioni di immagini

score 7 · Accepted Answer

Suppongo che il modo consigliato per la documentazione degli script Python sia l'utilizzo di ArgumentParser (si veda l'ultimo esempio su link ):

$ python prog.py --help
usage: prog.py [-h] [-v | -q] x y

calculate X to the power of Y

positional arguments:
  x              the base
  y              the exponent

optional arguments:
  -h, --help     show this help message and exit
  -v, --verbose
  -q, --quiet

what is the difference between this approach and the actual man pages?

Most of the developers here are working on Windows.

Le pagine man sono uno standard per i sistemi di tipo Unix. Pertanto, per questo specifico caso di script Python, trovo che sia meglio usare gli standard raccomandati dalla comunità Python per la documentazione.