Explained level options with examples #369
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the --log-level option by providing a dedicated "Log Levels" section with usage guidance and practical examples. This addresses issue #338 by making it easier for users to understand when and how to use different log levels.
Changes:
- Renamed "Command Reference" heading to "Reference" for brevity
- Added "Log Levels" section with a table describing when to use each level
- Provided three concrete examples showing INFO (default), NONE, and DEBUG output
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #369 +/- ##
==========================================
+ Coverage 91.38% 91.69% +0.31%
==========================================
Files 8 15 +7
Lines 1056 1120 +64
Branches 138 139 +1
==========================================
+ Hits 965 1027 +62
- Misses 69 70 +1
- Partials 22 23 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
README.md
Outdated
| Control duct's verbosity with `--log-level` (or `DUCT_LOG_LEVEL` environment variable): | ||
|
|
||
| | Level | Use when... | | ||
| |-------|-------------| |
There was a problem hiding this comment.
Recommendation: decide on alignment style
E.g.
| |-------|-------------| | |
| |:-------:|:-------------:| |
aligns to center
Currently
doesn't look quite as good as it 'could'
Up to you though
There was a problem hiding this comment.
went with center for levels, left for the text. thanks!
|
'Explained level options with examples' for PR title (CHANGELOG) One minor style suggestion These docs are getting quite sophisticated |
asmacdo
changed the title
2 participants
Closes #338