Specify default values for all documented parameters

未关闭
#149 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
55/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
python
领域
documentation

调研方向

Start with the function docstrings in the cf-plot Python package, using the width=0.02 example from the issue as a model. Look for parameters that default to None and get their real value from an if not <kwarg> check in the function body, and note each actual default. Done when every documented parameter states its default value in its docstring, matching what the code does.

由索引模型根据 Issue 内容生成。

描述

docs enhancement

There is currently mostly no indication of default values for the documented parameters in the function docstrings, and though in some cases this can be implied by the function signature (e.g. width=0.02), this isn't often a clue since in lots of cases the defaults are set after an if not <kwarg> check for None values. As per good (and indeed expected) docstring practice these should be added so the user knows what default value is used by the logic.

主要语言
Python
星标
21
派生
11
平均合并
2 天 21 小时
30 天内合并 PR
7

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

NCAS-CMS/cf-plot 的其他 Issue

查看 NCAS-CMS/cf-plot 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。