Skip to content

docs: Add comprehensive documentation for Gonfig derive macro - #15

Merged
0xvasanth merged 3 commits into
mainfrom
docs/add-gonfig-derive-macro-documentation
Oct 18, 2025
Merged

docs: Add comprehensive documentation for Gonfig derive macro#15
0xvasanth merged 3 commits into
mainfrom
docs/add-gonfig-derive-macro-documentation

Conversation

@0xvasanth

Copy link
Copy Markdown
Owner

Summary

  • Added comprehensive rustdoc documentation for the Gonfig derive macro
  • Documented all container-level attributes (env_prefix, allow_cli, allow_config)
  • Documented all field-level attributes (env_name, cli_name, default, skip)
  • Added configuration priority order explanation
  • Included complete usage examples
  • Fixed clippy warnings for uninlined format arguments across the codebase

Changes

Documentation

  • Added detailed derive macro documentation in gonfig_derive/src/lib.rs
  • Included examples for all attributes and use cases
  • Documented configuration merging priority

Code Quality

  • Fixed all clippy::uninlined_format_args warnings in:
    • src/builder.rs, src/cli.rs, src/config.rs
    • All example files
    • Test files

Test plan

  • All existing tests pass
  • Clippy passes with -D warnings
  • Pre-commit hooks pass
  • Documentation changes only for macro docs, no functional changes

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/
Copilot AI review requested due to automatic review settings October 18, 2025 17:25

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_args warnings 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.

@0xvasanth
0xvasanth merged commit a31f6d2 into main Oct 18, 2025
6 checks passed
@0xvasanth
0xvasanth deleted the docs/add-gonfig-derive-macro-documentation branch October 18, 2025 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants