ipfs/kubo

Document global options

Open

#2 583 ouverte le 19 avr. 2016

Voir sur GitHub
 (5 commentaires) (0 réactions) (0 assignés)Go (2 725 forks)batch import
help wantedtopic/docs-ipfs

Métriques du dépôt

Stars
 (13 906 stars)
Métriques de merge PR
 (Merge moyen 4j 2h) (28 PRs mergées en 30 j)

Description

timeout is a global option that can be passed to the CLI and to the HTTP API. It is referenced in a few places, like in ipfs diag net --help, but it isn't clear there that it is global, and it may seem that it is only relevant for those subcommands (like diag net). There should be a mention of global options, somewhere in the CLI man (and in the HTTP API docs, but we can get to that later).

The obvious place would be at the bottom of ipfs --help. What do you think?

Guide contributeur

Direction de recherche
Trouvez le code de génération du texte d'aide dans la CLI (probablement dans commands/help.go). Ajoutez une section pour les options globales comme timeout à la fin de la sortie de 'ipfs help'.
Stack technique
go
Domaine
clidocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
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
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80