openPMD/openPMD-api

Docs: IOTask-queue

Aberta

#153 aberto em 2 de mai. de 2018

Ver no GitHubGuia do colaborador
 (3 comentários) (0 reação) (2 responsáveis)C++ (57 forks)auto 404
documentationhelp wanted

Métricas do repositório

Stars
 (160 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Inspecione a classe IOTask queue em include/openPMD/IO/AbstractIOHandler.hpp e entenda seu papel. Observe as páginas existentes na seção Development do manual Sphinx para ver como o Breathe é usado para incluir a documentação do Doxygen e, em seguida, adicione uma nova página conceitual.
Pilha de tecnologia
cpp
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitC++Sphinx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75