MatrixHandlerTests.hpp (possibly others) tests undocumented
Open
@shakedregev is already working on this.
Since Mar 11, 2025.
documentation
testing
- Dominant language
- C++
- Stars
- 84
- Forks
- 13
- PR merge metrics
- No merged PRs in 30d
Description
Summary
Many files do not have documentation at all, or have very sparse documentation.
Rationale
The code can be hard to understand or follow, if it's not properly documented.
Description
The ideal fix is to go over files one by one (in different PRs, or perhaps by folder) and make sure they are properly documented. Some sections of the code lack documentation completely. This is the only way we can ensure nothing slips under the radar.
Additional information
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.