openPMD/openPMD-api

Docs: IOTask-queue

Open

#153 opened on May 2, 2018

View on GitHubContributor guide
 (3 comments) (0 reactions) (2 assignees)C++ (57 forks)auto 404
documentationhelp wanted

Repository metrics

Stars
 (160 stars)
PR merge metrics
 (PR metrics pending)

Description

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.

Contributor guide

Research direction
Inspect the IOTask queue class in include/openPMD/IO/AbstractIOHandler.hpp and understand its role. Look at existing pages in the Development section of the Sphinx manual to see how Breathe is used to include Doxygen documentation, then add a new conceptual page.
Tech stack
cpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC++Sphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75