feature/ETQ user, je veux un help plus complet
Situation
La commande idr_keygen possède un "help" ce qui est bien mais il me semble un peu light :
- Peut être ajouter une phrase indiquant ce que fait cette commande juste après le "usage" (comme ce qui se fait pour les commandes unix).
- Pour l'option "-t" on comprend qu'elle sert à indiquer le type de certificat qui va être générer mais peut être préciser l'usage du certificat suivant le type du certificat : "interactive" pour faire les connexions et "transfert-only" pour les transferts de données). Même si cela semble clair vu les noms des paramètres de l'option, il me semble important d'éviter le moindre doute pour les utilisateurs. De plus sans cette option, il apparaît que c'est un certificat "interactive" qui est crée donc peut être l'indiquer comme défaut.
- Vu que le help indique toutes les options entre des [..] dans le usage, je comprends donc que toutes les arguments sont optionnelles (ce qui ne sera pas nécessairement compris par tout le monde). J'ai donc lancé la commande sans option et effectivement la procédure de génération de certificat démarre mais on ne sait alors pas quel type de certificat est généré. Donc il serait bien de
- soit préciser le comportement par défaut de la commande dans le help (mais les utilisateurs risquent de ne pas le consulter),
- soit de modifier le comportement par défaut en affichant le help (ainsi les utilisateurs ont l'info).
- De même, que fait la commande si les options "-o OUTPUT, --output OUTPUT" ne sont pas spécifiées ? Perso, j'ai vu qu'elle crée un $HOME/key.zip .
Actions
-
https://docs.python.org/3/library/argparse.html#module-argparse
-
Voici un exemple de ce qui serait (à mon avis) bien pour la sortie du help (j'ai souligné ce que j'ai ajouté) :
$ idr_keygen --help
usage: idr_keygen [-h] [-t {interactive,transfert-only}] [-o OUTPUT]
IDRIS command generating SSHAM certificates which allow you to connect to jean-zay or to transfer data to or from jean-zay.
Puis suivant le comportement par défaut choisi :
By default, idr_keygen generates an interactive type certificat.
Or
By default, idr_keygen displays help information
optional arguments:
-h, --help show this help message and exit
-t {interactive,transfert-only}, --type {interactive,transfert-only}
selects SSH certificate type:
interactive type for login sessions (ssh), the default
transfert-only for data transferts (scp, sftp, bbcp,
bbftp et rsync)
-o OUTPUT, --output OUTPUT
ZIP Downloaded filename and location.
by default, creates file $HOME/key.zip
-
un warning disant que le type interactif a été utilisé par défaut
Edited by HARRY Guillaume