ipfs/kubo

Document global options

Open

#2.583 aberto em 19 de abr. de 2016

Ver no GitHub
 (5 comments) (0 reactions) (0 assignees)Go (2.725 forks)batch import
help wantedtopic/docs-ipfs

Métricas do repositório

Stars
 (13.906 stars)
Métricas de merge de PR
 (Mesclagem média 4d 2h) (28 fundiu PRs em 30d)

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?

Guia do colaborador

Direção de pesquisa
Encontre o código de geração de texto de ajuda na CLI (provavelmente em commands/help.go). Adicione uma seção para opções globais como timeout no final da saída de 'ipfs help'.
Pilha de tecnologia
go
Domain
clidocumentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80