[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