Repository navigation
Conversation
Collaborator
|
test:mpich/doc |
1 similar comment
Collaborator
|
test:mpich/doc |
sonjahapp
reviewed
Jul 16, 2026
sonjahapp
left a comment
Collaborator
There was a problem hiding this comment.
I reviewed text for MPI Session and spawn procedures. Text looks good to me except for the single comment I made on MPI_Comm_spawn.
Instructions and generating script in Box
We should only comment on performance if it is specifically verified with MPICH. It does not belong as a sementic block anyway.
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.
Pull Request Description
Currently documentation is very minimal or boilerplate and aimed at developers and those familiar with MPI. It leaves a gap for those learning MPI through MPICH and users looking to orient themselves in the large standard. As MPIX functions are not in the standard yet users have no easy way of looking up their usage beyond the one sentence description manpages have currently. The generated descriptions provide a way of getting more information for users who do not wish to scour the codebase or search for papers where the function was proposed.
Pull request provides semantic descriptions based off of the latest MPI Standard and source code.
Directions and script for making new descriptions in Box.
Author Checklist
Particularly focus on why, not what. Reference background, issues, test failures, xfail entries, etc.
Commits are self-contained and do not do two things at once.
Commit message is of the form:
module: short descriptionCommit message explains what's in the commit.
Whitespace checker. Warnings test. Additional tests via comments.
For non-Argonne authors, check contribution agreement.
If necessary, request an explicit comment from your companies PR approval manager.