docstring improvements
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 48/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
调研方向
Search for the docstrings of cf_xarray.bounds_to_vertices, vertices_to_bounds, shapely_to_cf, cf_to_shapely, and set_options, then compare them with the listed numpydoc warnings. Update the summaries, parameter and return documentation, See Also sections, and examples as applicable, and confirm that the reported validation warnings are resolved.
由索引模型根据 Issue 内容生成。
描述
Would be good to clean up these warnings
WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.bounds_to_vertices':
SS06: Summary should fit in a single line
PR03: Wrong parameters order. Actual: ('bounds', 'bounds_dim', 'core_dims', 'order'). Documented: ('bounds', 'bounds_dim', 'order', 'core_dims')
SA01: See Also section not found
EX01: No examples section found
WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.vertices_to_bounds':
SS06: Summary should fit in a single line
RT03: Return value has no description
SA01: See Also section not found
EX01: No examples section found
WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.shapely_to_cf':
GL01: Docstring text (summary) should start in the line immediately after the opening quotes (not in the same line, or leaving a blank line in between)
SA01: See Also section not found
EX01: No examples section found
WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.cf_to_shapely':
GL01: Docstring text (summary) should start in the line immediately after the opening quotes (not in the same line, or leaving a blank line in between)
SA01: See Also section not found
EX01: No examples section found
WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.set_options':
GL01: Docstring text (summary) should start in the line immediately after the opening quotes (not in the same line, or leaving a blank line in between)
ES01: No extended summary found
PR01: Parameters {'**kwargs'} not documented
PR02: Unknown parameters {'custom_criteria', 'warn_on_missing_variables'}
SA01: See Also section not found
- 主要语言
- Python
- 星标
- 181
- 派生
- 51
- 平均合并
- 6 小时 39 分钟
- 30 天内合并 PR
- 1
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
xarray-contrib/cf-xarray 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
xarray-contrib/cf-xarray#623 ·
-
Consider adding opt-in support for circular axes when calling `bounds_to_vertices` (related to #594)未关闭
难度 5/5 一周以上 新手友好度 38/100
xarray-contrib/cf-xarray#596 · 1 条评论 ·
-
难度 3/5 1-2 天 新手友好度 25/100
xarray-contrib/cf-xarray#570 ·
-
难度 4/5 3-5 天 新手友好度 15/100
xarray-contrib/cf-xarray#568 ·
-
难度 3/5 1-2 天 新手友好度 35/100
xarray-contrib/cf-xarray#566 · 2 条评论 ·
查看 xarray-contrib/cf-xarray 的全部 Issue
相似的 Issue
-
enhancement from-review
难度 2/5 1-3 小时 新手友好度 78/100
khuisman/mcp-gee-sweet#1010 ·
维护者通常 1 天内回复
-
bug confirmed issue
难度 2/5 1-3 小时 新手友好度 72/100
open-webui/open-webui#32333 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
ll7/robot_sf_ll7#10368 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 62/100
-
难度 2/5 1-3 小时 新手友好度 68/100
flop-labs/technocore-chat#982 ·
维护者通常 1 天内回复