Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve low-level API documentation #656

Merged
merged 7 commits into from
Oct 1, 2022
Merged

Improve low-level API documentation #656

merged 7 commits into from
Oct 1, 2022

Conversation

t-bltg
Copy link
Collaborator

@t-bltg t-bltg commented Oct 1, 2022 •
edited
Loading

Minor https://juliaparallel.org/MPI.jl/dev/reference/api/ improvements:

  • trim off trailing newline (appearing in the docstring, not in html files);
  • remove _c suffixed functions, as proposed by @giordano;
  • remove singleton MPIR_ prefixed function;
  • use MPI._doc_external;
  • simplify regex.

giordano
giordano reviewed Oct 1, 2022
View reviewed changes
gen/src/MPIgenerator.jl Outdated Show resolved Hide resolved
gen/src/generator.toml Outdated Show resolved Hide resolved
@t-bltg t-bltg force-pushed the docs_str branch 3 times, most recently from cc1645a to 395ca8d Compare October 1, 2022 12:46
@simonbyrne simonbyrne merged commit 8d36c1f into JuliaParallel:master Oct 1, 2022
@t-bltg t-bltg deleted the docs_str branch October 1, 2022 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@simonbyrne simonbyrne simonbyrne left review comments

@giordano giordano giordano left review comments

Assignees
No one assigned
Labels
API documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@t-bltg @giordano @simonbyrne