ipfs/kubo

Document global options

Open

#2,583 opened on 2016年4月19日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
help wantedtopic/docs-ipfs

説明

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?

コントリビューターガイド

技術スタック
go
領域
documentationcli
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic knowledge of Go CLI
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90
調査方針
The issue requests adding a mention of global options (e.g., timeout) to the CLI help output, specifically at the bottom of 'ipfs help'. The discussion indicates that the change should be made in the help text generation code, likely in the commands package. Review the existing code for how help text is generated and add a section for global options. No existing PR is linked.