[mkdocs] return type format in plotly.figure_factory functions
未關閉
還沒有人認領這個 Issue。
documentation
P2
- 主要語言
- Python
- 星號
- 18.8k
- 分支
- 2.8k
- 平均合併
- 16 小時 26 分鐘
- 30 天內合併 PR
- 21
描述
- After converting the docstrings of each function into numpy style, the return types are not as clear and might want to be edited for clarity. For example, the following return type for
create_facet_grid:
貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
研究方向
審查 plotly.figure_factory 函式的 NumPy 風格 docstring，從 issue 中的 create_facet_grid 回傳型別範例開始。在所有受影響的函式中一致地釐清回傳型別，並透過為每個回傳值提供清楚的文件來表示已完成。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 38/100