ipfs/kubo

Document global options

Open

#2583 aperta il 19 apr 2016

Vedi su GitHub
 (5 commenti) (0 reazioni) (0 assegnatari)Go (2725 fork)batch import
help wantedtopic/docs-ipfs

Metriche repository

Star
 (13.906 star)
Metriche merge PR
 (Merge medio 4g 2h) (28 PR mergiate in 30 g)

Descrizione

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?

Guida contributor

Direzione di ricerca
Trova il codice di generazione del testo di aiuto nella CLI (probabilmente in commands/help.go). Aggiungi una sezione per le opzioni globali come timeout alla fine dell'output di 'ipfs help'.
Tech stack
go
Dominio
clidocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80