-
Notifications
You must be signed in to change notification settings - Fork 283
Open
Labels
docDocumentation-related items.Documentation-related items.
Description
Is this a duplicate?
- I confirmed there appear to be no duplicate issues for this bug and that I agree to the Code of Conduct
Is this for new documentation, or an update to existing docs?
Update
Describe the incorrect/future/missing documentation
As discussed in #3964, documentation of BlockRadixRank
is confusing:
- It's not clear that radix rank does only ranks
RADIX_BITS
at a time as opposed to ranking the entire key. We should clearly explain in the documentation what's being ranked and support this with an example. - Code snippet is using signed integer for keys, which contradicts documentation "BlockRadixRank provides operations for ranking unsigned integer types". Radix rank expects bit-ordered keys and won't perform any twiddling. We should fix the code snippet.
- To avoid further issues, we should use literal include instead of a string with code snippet
- We should also clarify what rank stands for, but this is tracked by Unclear documentation #861
If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.
https://nvidia.github.io/cccl/cub/api/classcub_1_1BlockRadixRank.html
Metadata
Metadata
Assignees
Labels
docDocumentation-related items.Documentation-related items.
Type
Projects
Status
In Review