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

Fix cub::BlockAdjacentDifference documentation #542

Merged
merged 3 commits into from
Oct 13, 2023

Conversation

pauleonix
Copy link
Contributor

Fix factual errors, typos, copy-paste-errors

Description

closes #541

The documentation for BlockAdjacentDifference seemed very wonky to me both in formulation and in some of the example results provided for the example code snippets and even the order of arguments in one example. I tried correcting all flaws that I found (including some less important copy-paste mistakes and a typo) to the best of my knowledge both from reading the source code and trying it out on CompilerExplorer, but there might be more.

This PR was corresponds to NVIDIA/cub#724 where @senior-zero asked me to reapply the changes here.

Checklist

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

@pauleonix pauleonix requested review from a team as code owners October 11, 2023 12:41
@pauleonix pauleonix requested review from elstehle and miscco and removed request for a team October 11, 2023 12:41
@copy-pr-bot
Copy link

copy-pr-bot bot commented Oct 11, 2023

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.

cub/cub/block/block_adjacent_difference.cuh Outdated Show resolved Hide resolved
@miscco
Copy link
Collaborator

miscco commented Oct 11, 2023

Thanks a lot for finding and fixing those issues

@pauleonix
Copy link
Contributor Author

pauleonix commented Oct 11, 2023

@miscco "tripping over" them might be a more appropriate description than "finding" them 😆 Happy to help

@miscco
Copy link
Collaborator

miscco commented Oct 11, 2023

@pauleonix could you please add [skip ci] to the commit message.

We do not want to run CI for plain documentation changes

pauleonix and others added 2 commits October 11, 2023 15:19
Fix factual errors, typos, copy-paste-errors

[skip ci]
[skip ci]

Co-authored-by: Michael Schellenberger Costa <miscco@nvidia.com>
@pauleonix
Copy link
Contributor Author

pauleonix commented Oct 11, 2023

@miscco Like this or rather at the beginning of the title?

@miscco
Copy link
Collaborator

miscco commented Oct 11, 2023

/ok to test

@miscco
Copy link
Collaborator

miscco commented Oct 11, 2023

@miscco Like this or rather at the beginning of the title?

I believe it does not matter, but lets see ;)

cub/cub/block/block_adjacent_difference.cuh Outdated Show resolved Hide resolved
[skip ci]

Co-authored-by: Georgy Evtushenko <evtushenko.georgy@gmail.com>
@gevtushenko
Copy link
Collaborator

/ok to test

@jrhemstad jrhemstad merged commit 3bfffee into NVIDIA:main Oct 13, 2023
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.

[DOC]: cub::BlockAdjacentDifference documentation is faulty
4 participants