Add hpx::start nullptr overloads #3127
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
hkaiser
reviewed
Jan 25, 2018
msimberg
changed the title
hpx::start nullptr overloads
|
Added overloads to |
Merged
hkaiser
reviewed
Jan 26, 2018
| @@ -705,6 +707,18 @@ namespace hpx | |||
| inline int init(util::function_nonser<int(int, char**)> const& f, | |||
| int argc, char** argv, std::vector<std::string> const& cfg, | |||
| hpx::runtime_mode mode = hpx::runtime_mode_default); | |||
|
|
|||
| /// \cond NOINTERNAL | |||
There was a problem hiding this comment.
What's your rationale not to document the new overloads? Do you intend to deliberately leave them 'undocumented' (in the sense that the user is not supposed to use them)?
|
I did not mean for users not to use them. My thinking was that the
nullptr overloads are just an implementation detail to get the correct
behaviour for existing overloads, but in that case I should probably
document the behaviour in the affected overloads.
As a user, would you prefer to see the nullptr overloads explicitly
documented with separate entries or to have the nullptr behaviour
documented in the existing entries?
|
Having it documented as a special case with the other overloads would be preferred, I think. Something like: if |
|
I also added a further note about |
msimberg
force-pushed
the
hpx-start-overloads
branch
from
ef22f2f
to
488174c
Compare
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.
Proposed Changes
Adds overloads so that passing
nullptrtohpx::startwill only start up the runtime.This also adds a missing line to the docstrings of some
hpx::startoverloads.