openPMD/openPMD-api

Docs: IOTask-queue

Aperta

#153 aperta il 2 mag 2018

Vedi su GitHubGuida contributor
 (3 commenti) (0 reazioni) (2 assegnatari)C++ (57 fork)auto 404
documentationhelp wanted

Metriche repository

Star
 (160 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina la classe IOTask queue in include/openPMD/IO/AbstractIOHandler.hpp e comprendine il ruolo. Guarda le pagine esistenti nella sezione Development del manuale Sphinx per vedere come Breathe viene utilizzato per includere la documentazione Doxygen, quindi aggiungi una nuova pagina concettuale.
Tech stack
cpp
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitC++Sphinx
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75