DiamondLightSource / DiamondLightSource/python-tristan

Fill out the documentation

未关闭
#27 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
2
派生
1
PR 合并指标
30 天内没有已合并 PR

描述

Write user guide, some how-tos and finish the docstrings for automatic API documentation.

Release on Readthedocs.

贡献指南

这个仓库没有索引到贡献指南

调研方向

未指定文件、测试或入口点。首先调查项目,以确定面向用户的工作流、how-to 主题,以及自动 API 文档所需的 docstring。用户指南和 how-to 编写完成、docstring 完整,并且文档已在 Read the Docs 上发布时,工作即告完成。

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

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
30/100

把新 issue 发到你的邮箱

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