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.

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

[docs] Fix broken links and remove references to non-existing docstrings #569

Merged
merged 2 commits into from
Apr 18, 2022

Conversation

giordano
Copy link
Member

No description provided.

@@ -23,5 +23,4 @@ MPI.Is_thread_main
MPI.Initialized
MPI.Finalize
MPI.Finalized
MPI.universe_size
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a duplicate of https://github.com/JuliaParallel/MPI.jl/blob/5cf57d8a289a80f7e550a165863ef0dd40667370/docs/src/comm.md#miscellaneous, I feel like this function is better placed in the communication section, but I'm happy to swap it if you think it's better.

@@ -11,29 +11,11 @@ MPI.Group
MPI.Comparison
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All docstrings I'm removing from this file were added in #521, but these functions/constants never had docstrings.

Copy link
Member

@vchuravy vchuravy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we also get Documenter to yell at us for missing targets?

@giordano
Copy link
Member Author

There are warnings, see for example https://github.com/JuliaParallel/MPI.jl/runs/6066841377?check_suite_focus=true. In this PR I'm enabling colours to make those a bit more evident, if someone actually reads the logs. But you probably want to make test fails with missing docstrings? I'll see if there is this option, it'd indeed be useful, it isn't the first time I do a PR like this (#520) 😄

@giordano giordano merged commit 844d26e into JuliaParallel:master Apr 18, 2022
@giordano giordano deleted the mg/docs branch April 18, 2022 20:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants