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