NVIDIA / NVIDIA/cccl

Improve documentation of `vsmem_helper_default_fallback_policy_t`

Open
#1,702 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
2.5k
Forks
487
Avg merge
2d 7h
Merged PRs (30d)
296

Description

The documentation is lying to me. It says the alias is to `vsmem_helper_t`, but it aliases to `vsmem_helper_fallback_policy_t`. This may be a copy&paste error from above?

_Originally posted by @bernhardmgruber in https://github.com/NVIDIA/cccl/pull/1643#discussion_r1589338190_

Contributor guide

Open the contributing guide

Research direction

Locate the documentation for `vsmem_helper_default_fallback_policy_t` and compare its stated alias with `vsmem_helper_fallback_policy_t`. Correct the documentation so it names the actual aliased type. Done means the documentation no longer refers to `vsmem_helper_t`.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.