Skip to content

cuda.cccl.parallel: Reference examples in docstrings rather than tests #5430

@shwina

Description

@shwina

Right now, our docstrings reference tests from modules test_<something>_api.py. See for example:

.. literalinclude:: ../../python/cuda_cccl/tests/parallel/test_transform.py

However, we now have a dedicated examples/ directory containing example files (which are also tested on CI):

https://github.com/NVIDIA/cccl/tree/main/python/cuda_cccl/tests/parallel/examples/transform

We should:

  • Move tests from out of test_<something>_api.py files, either into the corresponding test_<something>.py file, or to the corresponding example file (depending on whether they are currently referenced in docstrings)
  • Change existing docstrings to exclusively reference examples

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

In Review

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions