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

[DOC]: cuda.parallel: Update documentation to include iterators and how to use them #3169

Open
1 task done
shwina opened this issue Dec 14, 2024 · 0 comments
Open
1 task done
Assignees
Labels
doc Documentation-related items.

Comments

@shwina
Copy link
Contributor

shwina commented Dec 14, 2024

Is this a duplicate?

Is this for new documentation, or an update to existing docs?

New

Describe the incorrect/future/missing documentation

Currently, the docs are picking up and rendering the docstring for _iterators.IteratorBase which is an internal class. Instead, we should document e.g., CountingIterator, TransformIterator. etc., from iterators.py and ensure their docstrings are rendered.

https://nvidia.github.io/cccl/cuda_parallel/

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/cuda_parallel/

@shwina shwina added the doc Documentation-related items. label Dec 14, 2024
@github-project-automation github-project-automation bot moved this to Todo in CCCL Dec 14, 2024
@shwina shwina self-assigned this Dec 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation-related items.
Projects
Status: Todo
Development

No branches or pull requests

1 participant