donnemartin/gitsome

Provide man pages

Open

#62 ouverte le 8 juin 2016

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Python (476 forks)batch import
feature-requesthelp wanted

Métriques du dépôt

Stars
 (7 494 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

At the moment help can be got through --help. This is fine but not quite as intuitive as it could be: it is customary, that help can also be invoked though gh help|--help|-h <command>, gh <command> --help|-h and man gh <command>. Usually also man pages are used as default, so that using the help commands or switches would merely open the man page.

Guide contributeur

Direction de recherche
Explorez la sortie actuelle de help et créez des pages de manuel en utilisant un outil comme argparse manpage ou manuellement. Mettez à jour le script de construction pour installer les pages de manuel.
Stack technique
python
Domaine
clidocumentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75