[oneDPL] Create a subsection for is_execution_policy type trait #567
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
source/elements/oneDPL/source/parallel_api/execution_policies.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: Dan Hoeflinger <dan.hoeflinger@intel.com>
rarutyun
reviewed
Aug 20, 2024
source/elements/oneDPL/source/parallel_api/execution_policies.rst
Outdated
Show resolved
Hide resolved
source/elements/oneDPL/source/parallel_api/execution_policies.rst
Outdated
Show resolved
Hide resolved
source/elements/oneDPL/source/parallel_api/execution_policies.rst
Outdated
Show resolved
Hide resolved
rarutyun
reviewed
Aug 21, 2024
source/elements/oneDPL/source/parallel_api/execution_policies.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: Ruslan Arutyunyan <ruslan.arutyunyan@intel.com>
| ``is_execution_policy<T>`` must have the characteristics of ``std::true_type`` if ``T`` is one of the above specified | ||
| or implementation-defined execution policy types, otherwise it must have the characteristics of ``std::false_type``. | ||
| Following the C++ Standard, ``is_execution_policy<T>`` does not automatically strip references and cv-qualifiers | ||
| from its template argument. [*Note*: Use it with ``std::decay_t<T>`` or similar type transformation utilities. -- *end note*] |
There was a problem hiding this comment.
Optional: It is a little strange to have this inline note directly followed by a multi-line note.
I think it may be better to either remove the note descriptor and wrapping and just tag on to the previous sentence: " and is best used in combination with ``std::decay_t'' or similar type transformation utilities"
-or-
We can remove this note from the spec in favor of some similar advice in the oneDPL documentation. We may be able to assume some level of sophistication of someone reading this specification, where the previous sentence implies this note.
danhoeflinger
approved these changes
Sep 16, 2024
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.
This PR describes oneDPL
is_execution_policytrait in more detail, and also addresses #558.