Merged
Conversation
Signed-off-by: Dan Hoeflinger <dan.hoeflinger@intel.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR cleans up header comment blocks under include/oneapi/dpl/internal/random_impl/ to avoid implying these internal headers are “public” headers, and rewords the Philox header’s reference to cppreference to be less prescriptive.
Changes:
- Removed the “Abstract / Public header file …” comment blocks from multiple internal random implementation headers.
- Replaced the Philox header’s multi-line “Abstract” block with a single descriptive link line.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| include/oneapi/dpl/internal/random_impl/weibull_distribution.h | Removes misleading “public header” abstract comment. |
| include/oneapi/dpl/internal/random_impl/uniform_real_distribution.h | Removes misleading “public header” abstract comment. |
| include/oneapi/dpl/internal/random_impl/uniform_int_distribution.h | Removes misleading “public header” abstract comment. |
| include/oneapi/dpl/internal/random_impl/subtract_with_carry_engine.h | Removes misleading “public header” abstract comment. |
| include/oneapi/dpl/internal/random_impl/random_common.h | Removes misleading “public header” abstract comment. |
| include/oneapi/dpl/internal/random_impl/philox_engine.h | Rewords/replaces the abstract block with a descriptive cppreference link line. |
| include/oneapi/dpl/internal/random_impl/normal_distribution.h | Removes misleading “public header” abstract comment. |
| include/oneapi/dpl/internal/random_impl/lognormal_distribution.h | Removes misleading “public header” abstract comment. |
| include/oneapi/dpl/internal/random_impl/linear_congruential_engine.h | Removes misleading “public header” abstract comment. |
| include/oneapi/dpl/internal/random_impl/geometric_distribution.h | Removes misleading “public header” abstract comment. |
| include/oneapi/dpl/internal/random_impl/extreme_value_distribution.h | Removes misleading “public header” abstract comment. |
| include/oneapi/dpl/internal/random_impl/exponential_distribution.h | Removes misleading “public header” abstract comment. |
| include/oneapi/dpl/internal/random_impl/discard_block_engine.h | Removes misleading “public header” abstract comment. |
| include/oneapi/dpl/internal/random_impl/cauchy_distribution.h | Removes misleading “public header” abstract comment. |
| include/oneapi/dpl/internal/random_impl/bernoulli_distribution.h | Removes misleading “public header” abstract comment. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ElenaTyuleneva
previously approved these changes
Mar 23, 2026
Contributor
ElenaTyuleneva
left a comment
ElenaTyuleneva
left a comment
There was a problem hiding this comment.
The changes look reasonable to me.
Co-authored-by: ElenaTyuleneva <elena.tyuleneva@intel.com>
ElenaTyuleneva
approved these changes
Mar 23, 2026
This file contains hidden or 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
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.
As far as I understand, these are not public headers, and shouldn't claim to be in their comments.
I reworded the reference to cppreference, as I don't believe we should be referring to that as documentation for our features directly. Happy to discuss this if someone objects.
I came across this in review of #2620, where someone was including one of these headers directly.