AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

Improve documentation for running unit tests

Open
#1,868 4 comments 0 reactions 1 assignee Claimed by @drewavisautodesk View on GitHub
devdays25 Documentation good first issue help wanted
Dominant language
C++
Stars
2.1k
Forks
503
PR merge metrics
No merged PRs in 30d

Description

The documentation on [Contributing](https://opencolorio.readthedocs.io/en/latest/guides/contributing/contributing.html) has some basic information about running the unit tests. However, it would be helpful to extend that to cover situations such as:
- Running individual tests rather than all tests
- Running only the CPU, GPU, or Python tests rather than all tests

For example, this will run only the CPU unit tests from the Builtins suite:
`tests/cpu/test_cpu_exec --run_only Builtins`

And this will run just Python test:
`python3 ../tests/python/OpenColorIOTestSuite.py $PWD`

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.