Refactor and document parts of pika/init.hpp
#825
Merged
Conversation
This file contains 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
msimberg
commented
Oct 25, 2023
msimberg
commented
Oct 25, 2023
libs/pika/init_runtime/include/pika/init_runtime/init_runtime.hpp
Outdated
Show resolved
Hide resolved
msimberg
force-pushed
the
init-etc-refactor
branch
3 times, most recently
from
cb378b7 to
97d7f3e
Compare
|
Open for reviews, but not ready to be merged yet. This will be a breaking change for DLA-Future but we can prepare for it in DLA-Future. In particular, #825 (comment) still needs to be dealt with. |
msimberg
force-pushed
the
init-etc-refactor
branch
5 times, most recently
from
6c6196e to
7f42030
Compare
|
cscs-ci run |
… starting runtime
pika::finalize now returns void. Explicitly return EXIT_SUCCESS instead.
msimberg
force-pushed
the
init-etc-refactor
branch
from
7f42030 to
9f532a0
Compare
|
cscs-ci run |
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
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.
Fixes #703 and does some additional refactoring at the same time.
intreturn type from functions that don't have anything useful to return. The only functions that keep theintreturn type arepika::stopandpika::initbecause they can return the value frompika_main.error_codeparameter from allpika::start,pika::stop, etc. functions inpika/init.hpp.pika::start,pika::stop,pika::finalize,pika::wait,pika::resume, andpika::suspend. I have not addedpika::initor overloads ofpika::startthat take a function as their future is uncertain (I would like to remove them, but I'm still unsure). I'm still unsure about the contents ofinit_paramsso I haven't documented any of the members.This adds the API documentation through doxygen and breathe, and manually adding the functions that we want to present in the documentation. I've also added a small snippet showing how to use some functions in the
pika/init.hppheader. I think this is a pattern that we can follow for most headers and/or functions/classes to show the typical use cases.