Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor inline comments #581

Merged
merged 1 commit into from
Oct 23, 2023

Conversation

gevtushenko
Copy link
Collaborator

Description

closes #547

This PR is a necessary step before setting up automatic formatting.
It removes inline comments from CUB sources.

Checklist

  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@gevtushenko gevtushenko requested review from a team as code owners October 18, 2023 23:22
@gevtushenko gevtushenko requested review from elstehle and alliepiper and removed request for a team October 18, 2023 23:22
Comment on lines +103 to +120
/// The BlockLoad algorithm to use
static constexpr BlockLoadAlgorithm LOAD_ALGORITHM = _LOAD_ALGORITHM;

/// Cache load modifier for reading keys (and values)
static constexpr CacheLoadModifier LOAD_MODIFIER = _LOAD_MODIFIER;

static constexpr BlockLoadAlgorithm LOAD_ALGORITHM = _LOAD_ALGORITHM; ///< The BlockLoad algorithm to use
static constexpr CacheLoadModifier LOAD_MODIFIER = _LOAD_MODIFIER; ///< Cache load modifier for reading keys (and values)
static constexpr RadixRankAlgorithm RANK_ALGORITHM = _RANK_ALGORITHM; ///< The radix ranking algorithm to use
static constexpr BlockScanAlgorithm SCAN_ALGORITHM = _SCAN_ALGORITHM; ///< The BlockScan algorithm to use
/// The radix ranking algorithm to use
static constexpr RadixRankAlgorithm RANK_ALGORITHM = _RANK_ALGORITHM;

/// The BlockScan algorithm to use
static constexpr BlockScanAlgorithm SCAN_ALGORITHM = _SCAN_ALGORITHM;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not a fan of comments that are essentially respellings of the variable name.

That is the reason you just want good descriptive names

@gevtushenko gevtushenko force-pushed the enh-main/github/inline_comments branch from 8ddfb20 to 97dcbe1 Compare October 21, 2023 16:40
@jrhemstad jrhemstad merged commit ff3b6f1 into NVIDIA:main Oct 23, 2023
505 of 513 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Refactor inline CUB API documentation
5 participants