openPMD / openPMD/openPMD-api

API Doxygen: Collective

Open
#141 1 comment 0 reactions 1 assignee Claimed by @anokfireball View on GitHub
documentation
Dominant language
C++
Stars
161
Forks
59
Avg merge
2d 22h
Merged PRs (30d)
7

Description

Some of the public APIs still lack proper doxygen docs for their parameters.

Even more important, behaviour such as required collective calls (for the current MPI_Communicator) such as Series constructors/destructors, store/loadChunk, attribute writing, ... need be to mentioned in the respective method descriptions to avoid confusion.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.