openPMD/openPMD-api

Docs: IOTask-queue

Offen

#153 geöffnet am 02.05.2018

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (0 Reaktionen) (2 zugewiesene Personen)C++ (57 Forks)auto 404
documentationhelp wanted

Repository-Metriken

Stars
 (160 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Untersuche die IOTask queue Klasse in include/openPMD/IO/AbstractIOHandler.hpp und verstehe ihre Rolle. Schau dir bestehende Seiten im Development Abschnitt des Sphinx Handbuchs an, um zu sehen, wie Breathe verwendet wird, um Doxygen Dokumentation einzubinden, und füge dann eine neue konzeptionelle Seite hinzu.
Tech Stack
cpp
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitC++Sphinx
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75