docs: Add comprehensive documentation for Gonfig derive macro - #15
Merged
Conversation
Add detailed rustdoc comments to the Gonfig derive macro including: - Overview of generated methods - Container attributes (env_prefix, allow_cli, allow_config) - Field attributes (env_name, cli_name, default, skip) - Configuration priority order - Complete usage examples Also fix clippy warnings for uninlined format arguments across: - src/builder.rs, src/cli.rs, src/config.rs - examples/ - tests/
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the Gonfig derive macro and fixes clippy warnings for uninlined format arguments across the codebase.
- Added detailed rustdoc documentation for all container and field-level attributes
- Fixed
clippy::uninlined_format_argswarnings by using inline format syntax - Updated version numbers from 0.1.5 to 0.1.6
Reviewed Changes
Copilot reviewed 14 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| gonfig_derive/src/lib.rs | Added comprehensive derive macro documentation with examples for all attributes |
| src/config.rs | Fixed uninlined format args in error messages |
| src/cli.rs | Fixed uninlined format args in serialization error |
| src/builder.rs | Fixed uninlined format args in deserialization error |
| tests/debug_env.rs | Fixed uninlined format args in debug println |
| examples/*.rs | Fixed uninlined format args in various print statements |
| Cargo.toml files | Bumped version from 0.1.5 to 0.1.6 |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Gonfigderive macroChanges
Documentation
gonfig_derive/src/lib.rsCode Quality
clippy::uninlined_format_argswarnings in:src/builder.rs,src/cli.rs,src/config.rsTest plan
-D warnings