google / google/python-fire

default values should be visible in help screen

未關閉
#184 11 則留言 12 個 reaction 已指派 0 人 在 GitHub 檢視
enhancement
主要語言
Python
星號
28.2k
分支
1.5k
PR 合併指標
30 天內沒有已合併 PR

描述

As per #114 the default value for an argument should be visible in the help screen.

Some considerations:
- If the default value is a simple type and not too long in length, we can just show it.
- If it doesn't serialize well (either because there's no good way to serialize it, or because its serialization is too long to show comfortably), then we need to determine a clean alternative to showing the default. Using the type may be one option for this alternative.

貢獻指南

開啟貢獻指南

研究方向

首先閱讀 #114 中的討論,並追蹤 Python Fire 如何產生 CLI 說明畫面以及取得引數預設值。定義什麼樣的預設值算是簡短且可序列化的,並定義對於過長或難以序列化的值所使用的 fallback;當說明輸出為每個引數顯示適當的預設值時,即視為完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
cli
Issue 類型
功能
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
基本清楚
新手友好度
30/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。