Review all log level `Wrapper` documentation (`Wrapper::appendDescription()`),
Open
Nobody has claimed this yet.
- #3089 by @arng40 — closed without merging
- Dominant language
- C++
- Stars
- 287
- Forks
- 109
- Avg merge
- 4d 41m
- Merged PRs (30d)
- 5
Description
The user need is to know what effect log levels values can have on the log output.
Proposal: add documentation on all existing logLevel wrappers & enforce to add description when enabling the logLevel wrapper.
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 locating Wrapper::appendDescription() and reviewing every existing logLevel wrapper. The work is done when each wrapper documents its effect on log output and enabling a logLevel wrapper requires a description; the linked pull request #3089 may provide prior context.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100