openPMD/openPMD-api

Docs: IOTask-queue

开放

#153 创建于 2018年5月2日

在 GitHub 查看贡献者指南
 (3 条评论) (0 个反应) (2 位负责人)C++ (57 个派生)auto 404
documentationhelp wanted

仓库指标

星标
 (160 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

Since it is such a central concept, the IOTask-queue deserves a conceptual documentation in the Development section of our sphinx manual.

@C0nsultant can you please add a little page on it? Be aware that breathe allows you do plainly include doxygen doc strings of namespaces, classes, defines, etc. where needed. With that you can avoid writing the same text twice, if e.g. the openPMD::IOTask class already has a good doxygen doc.

贡献者指南

研究方向
检查include/openPMD/IO/AbstractIOHandler.hpp中的IOTask queue类，并理解其作用。查看Sphinx手册Development部分中的现有页面，了解如何使用Breathe包含Doxygen文档，然后添加一个新的概念页面。
技术栈
cpp
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GitC++Sphinx
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75