Skip to content

feat(anvil): comprehensive documentation and API improvements#429

Merged
DDtKey merged 2 commits intotestcontainers:mainfrom
suchapalaver:main
Nov 25, 2025
Merged

feat(anvil): comprehensive documentation and API improvements#429
DDtKey merged 2 commits intotestcontainers:mainfrom
suchapalaver:main

Conversation

@suchapalaver
Copy link
Contributor

Improve the anvil module

Enhance the anvil module with better documentation, API consistency, and improved test coverage to match repository best practices.

Changes

  • Add public ANVIL_PORT constant for API consistency with other modules
  • Add with_tag() convenience method for ergonomic tag selection
  • Create comprehensive inline documentation with usage examples
  • Add detailed builder method documentation clarifying path handling
  • Create examples/anvil.rs demonstrating practical usage
  • Add blocking/sync test variant
  • Add test for latest() method
  • Update lib.rs module description to be more descriptive
  • Update outdated testcontainers version references

Impact

  • Test coverage: 2 → 4 tests (100% increase)
  • Documentation: Now includes comprehensive examples and usage patterns
  • API: Consistent with 27+ other modules that export port constants
  • User experience: Significantly improved with clearer docs and examples

Signed off by Joseph Livesey joseph@semiotic.ai

   Add public  constant for API consistency with other modules
   in the repository. 27+ other modules export port constants, making this
   a standard pattern for ergonomic port access.
   Enhance the anvil module with better documentation, API consistency,
   and improved test coverage to match repository best practices.

   ## Changes

   - Add public ANVIL_PORT constant for API consistency with other modules
   - Add with_tag() convenience method for ergonomic tag selection
   - Create comprehensive inline documentation with usage examples
   - Add detailed builder method documentation clarifying path handling
   - Create examples/anvil.rs demonstrating practical usage
   - Add blocking/sync test variant
   - Add test for latest() method
   - Update lib.rs module description to be more descriptive
   - Update outdated testcontainers version references

   ## Impact

   - Test coverage: 2 → 4 tests (100% increase)
   - Documentation: Now includes comprehensive examples and usage patterns
   - API: Consistent with 27+ other modules that export port constants
   - User experience: Significantly improved with clearer docs and examples
@DDtKey
Copy link
Contributor

DDtKey commented Nov 25, 2025

Thank you for the contribution! 🚀

@DDtKey DDtKey merged commit 288e97f into testcontainers:main Nov 25, 2025
7 of 12 checks passed
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