Add variable types and descriptions to `plasma_main_page()`

未关闭 适合新手
#4,669 0 条评论 0 个 reaction 已指派 1 人 在 GitHub 查看

维护者通常 1 天内回复

@timothy-nunn 已经在做这个了。

开始于 2026年10月21日。

评估

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

调研方向

目标是 plasma_main_page() 函数,它的 docstring 需要为每个变量补充类型和描述。issue 中的截图展示了渲染后的页面,因此请将页面上列出的变量与函数参数以及读取这些变量的代码进行对照。遵循同一模块中相邻函数的 docstring 风格。完成标准是页面上列出的每个变量都有类型和一行描述,并且文档构建或 doctest 仍然通过。

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

描述

papercut

This fn needs variable types and descriptions added in the docstring

Image
主要语言
Python
星标
75
派生
29
平均合并
1 天 17 小时
30 天内合并 PR
28

环境准备

从这里开始

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

ukaea/PROCESS 的其他 Issue

查看 ukaea/PROCESS 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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