ipfs/kubo

Document global options

Open

#2,583 建立於 2016年4月19日

在 GitHub 查看
 (5 留言) (0 反應) (0 負責人)Go (13,906 star) (2,725 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.