PointCloudLibrary / PointCloudLibrary/pcl
Define PCL Documentation style guide
Open
Nobody has claimed this yet.
kind: todo
module: docs
needs: feedback
skill: doxygen
- Dominant language
- C++
- Stars
- 11.1k
- Forks
- 4.7k
- Avg merge
- 4d 10h
- Merged PRs (30d)
- 6
Description
As per https://github.com/PointCloudLibrary/pcl/issues/642#issuecomment-40587598 @taketwo's comment:
I think it is important to discuss "PCL documentation style guide" (line width, blank lines, use of \brief command, academic citations, etc.)
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
Start by reading issue #642 and the referenced comment, then review the PCL documentation conventions currently in use. Done means producing an agreed style guide that addresses line width, blank lines, \brief usage, academic citations, and other documented conventions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100