docs: functions returning should start description with "Returns..."
Open
documentation
- Dominant language
- C++
- Stars
- 299
- Forks
- 43
- PR merge metrics
- No merged PRs in 30d
Description
E.g. https://www.boost.org/doc/libs/master/libs/mysql/doc/html/mysql/ref/boost__mysql__date/get_time_point.html
"Return *this as a time_point , without validity checking"
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the documentation page linked in the issue and trace it to the corresponding API documentation source. Review descriptions for functions that return values, update them to begin with “Returns...”, and verify the generated documentation uses the corrected wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100