Repository navigation
docs(io): render the save overloads that take a communicator - #785
Merged
Merged
Conversation
The Doxyfile defines SAMURAI_WITH_MPI, so Doxygen parses the MPI-only save overloads and Breathe renders them like the others. The API page claimed the opposite and left them out.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
docs/source/api/io.mdsaid the API reference is generated without MPI and does not render thesaveoverloads that take a communicator. It is the other way round:docs/DoxyfilesetsPREDEFINED = SAMURAI_INLINE= SAMURAI_WITH_MPI, so Doxygen parses the four overloads (template parameterdetail::mpi_communicator Comm) and Breathe can render them.The page now renders them with
doxygenfunction, like the other overloads, and drops the wrong sentence. It also says thatlocal_savetakes the arguments of thesaveoverloads without a communicator, since it has none with one.No other page assumes a reference built without MPI (grep of
docs/sourcefor "without MPI", "MPI build", "does not render"), anddumpandloadhave no communicator overloads.Doxygen and
sphinx-build -b html -W --keep-going, run as in thedocsCI job, report no warning. The renderedapi/io.htmllists the 8saveand 4local_savesignatures.