Skip to content

docs: add missing doxygen comment for par_nosync_t::on()#9196

Open
Oxygen56 wants to merge 1 commit into
NVIDIA:mainfrom
Oxygen56:fix/issue-5453
Open

docs: add missing doxygen comment for par_nosync_t::on()#9196
Oxygen56 wants to merge 1 commit into
NVIDIA:mainfrom
Oxygen56:fix/issue-5453

Conversation

@Oxygen56
Copy link
Copy Markdown

Summary

Fixes #5453

Test Plan

  • Comment format matches project Doxygen style
  • Change is consistent with par_t::on() documentation

@Oxygen56 Oxygen56 requested a review from a team as a code owner May 31, 2026 02:24
@Oxygen56 Oxygen56 requested a review from gevtushenko May 31, 2026 02:24
@github-project-automation github-project-automation Bot moved this to Todo in CCCL May 31, 2026
@copy-pr-bot
Copy link
Copy Markdown
Contributor

copy-pr-bot Bot commented May 31, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@cccl-authenticator-app cccl-authenticator-app Bot moved this from Todo to In Review in CCCL May 31, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 31, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 2773414d-6987-4579-b185-4acf32bb4dd1

📥 Commits

Reviewing files that changed from the base of the PR and between ba66046 and 415e31b.

📒 Files selected for processing (1)
  • thrust/thrust/system/cuda/detail/execution_policy.h
✅ Files skipped from review due to trivial changes (1)
  • thrust/thrust/system/cuda/detail/execution_policy.h

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated internal developer documentation comments; no functional or user-facing changes.

suggestion:

Walkthrough

A Doxygen comment was added to document par_nosync_t.on(cudaStream_t), indicating it sets the CUDA stream for algorithms executed with this policy. No code or API signatures were changed.

Changes

par_nosync_t Documentation

Layer / File(s) Summary
par_nosync_t stream documentation
thrust/thrust/system/cuda/detail/execution_policy.h
Doxygen comment added to describe the par_nosync_t.on(cudaStream_t) method that configures the CUDA stream for execution.

Assessment against linked issues

Objective Addressed Explanation
Add documentation for thrust::cuda::par_nosync.on method [#5453]

Out-of-scope changes

No out-of-scope changes detected. The modification is limited to adding documentation for the par_nosync_t.on() method as required by the linked issue.


Comment @coderabbitai help to get the list of available commands and usage tips.

@bernhardmgruber
Copy link
Copy Markdown
Contributor

/ok to test ba66046

@github-actions

This comment has been minimized.

@bernhardmgruber
Copy link
Copy Markdown
Contributor

/ok to test aa93378

@github-actions

This comment has been minimized.

@bernhardmgruber
Copy link
Copy Markdown
Contributor

/ok to test 97151a9

@github-actions

This comment has been minimized.

@bernhardmgruber
Copy link
Copy Markdown
Contributor

@Oxygen56 please don't merge main, since CI runs are rather expensive, and rerunning failed PRs is often cheaper. Now the CI passed and I can't merge the PR because of the merge commit :S

@bernhardmgruber
Copy link
Copy Markdown
Contributor

/ok to test 490ec1a

@bernhardmgruber bernhardmgruber enabled auto-merge (squash) June 2, 2026 15:38
Fixes NVIDIA#5453

Adds the //! Sets the stream documentation comment that par_t::on()
already has, fixing the documentation inconsistency between the two
execution policy types.
auto-merge was automatically disabled June 2, 2026 17:58

Head branch was pushed to by a user without write access

@Oxygen56
Copy link
Copy Markdown
Author

Oxygen56 commented Jun 2, 2026

@bernhardmgruber Sorry about that! I've cleaned up the branch — force-pushed a single clean commit without the merge commits. CI should run cleanly now. Thanks for the approval and your patience!

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

😬 CI Workflow Results

🟥 Finished in 2h 47m: Pass: 91%/116 | Total: 4d 06h | Max: 2h 28m | Hits: 26%/923873

See results here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Review

Development

Successfully merging this pull request may close these issues.

[BUG]: Documentation for thrust::cuda::par_nosync.on missing

2 participants