AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO
Documentation C++ tab eats whitespace in prototypes
- Dominant language
- C++
- Stars
- 2.1k
- Forks
- 503
- PR merge metrics
- No merged PRs in 30d
Description
When looking at a documentation page such as:
https://opencolorio.readthedocs.io/en/latest/api/colorspace.html
If you switch from the default Python to the C++ tab, function prototypes have most of the whitespace stripped away, for instance:
constchar*getName()constnoexcept
I can reproduce this on both Chrome and Firefox on macOS (current versions).

Contributor guide
Research direction
Start with the API documentation page at https://opencolorio.readthedocs.io/en/latest/api/colorspace.html and switch from the Python tab to the C++ tab to reproduce the formatting problem. Trace the documentation rendering or tab configuration responsible for the C++ prototypes, and verify that declarations such as const char* getName() const noexcept retain their whitespace.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100