PointCloudLibrary / PointCloudLibrary/pcl
Treat warnings as errors in Documentation CI job
Open
Nobody has claimed this yet.
kind: todo
status: triage
- Dominant language
- C++
- Stars
- 11.1k
- Forks
- 4.7k
- Avg merge
- 4d 10h
- Merged PRs (30d)
- 6
Description
To conclude the work done in #642, there's a need for:
- fixing non-documentation Doxygen warnings (#3701, #3905, #3932, #3933, );
- defining a style guide for the documentation (#3948);
- adding the missing documentation (it seems from #3701 that it's at least 10 parameters, but likely a bit more)
- fix LaTeX-only warnings (if they exist);
- fix Sphinx-only warnings (they exist);
- set
WARN_AS_ERROR= YES; - set
warning-is-error= 1in sphinx's setup.cfg or-Win invocation (still have to look for it).
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.
Research direction
Review the Documentation CI job, the linked Doxygen configuration, and Sphinx's setup.cfg or invocation to locate where warnings are currently handled. Use the referenced issues to identify remaining warning categories; done means the listed documentation, LaTeX, Sphinx, and non-documentation warnings are resolved and both warning-as-error settings are enabled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, latex
- Domain
- build-system, ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100