Skip to content

docs: Extend WithCommand(params string[]) documentation#1685

Open
HofmeisterAn wants to merge 1 commit intodevelopfrom
feature/update-with-command-api-doc
Open

docs: Extend WithCommand(params string[]) documentation#1685
HofmeisterAn wants to merge 1 commit intodevelopfrom
feature/update-with-command-api-doc

Conversation

@HofmeisterAn
Copy link
Copy Markdown
Collaborator

@HofmeisterAn HofmeisterAn commented Apr 28, 2026

What does this PR do?

Extends the WithCommand(params string[]) documentation.

Why is it important?

-

Related issues

Summary by CodeRabbit

  • Documentation
    • Clarified how command arguments are handled in container configuration, including details on appending versus overwriting behavior.
    • Added guidance on composing command arguments with existing configurations.
    • Updated documentation with reference to external composing command arguments guide.

@HofmeisterAn HofmeisterAn added the documentation Docs, docs, docs. label Apr 28, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 28, 2026

Deploy Preview for testcontainers-dotnet ready!

Name Link
🔨 Latest commit 8567bf7
🔍 Latest deploy log https://app.netlify.com/projects/testcontainers-dotnet/deploys/69f048606d21390008c5ba92
😎 Deploy Preview https://deploy-preview-1685--testcontainers-dotnet.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 3d4b5f4d-d94f-42d8-939f-85439ca5738f

📥 Commits

Reviewing files that changed from the base of the PR and between e72bacc and 8567bf7.

📒 Files selected for processing (1)
  • src/Testcontainers/Builders/IContainerBuilder2.cs`

Walkthrough

The PR corrects the XML documentation for the WithCommand method overloads, changing the description from "overrides command arguments" to "appends command arguments." It adds comprehensive remarks explaining how module-configured commands are handled, how to use different overloads for appending versus overwriting, and includes a reference to external documentation.

Changes

Cohort / File(s) Summary
XML Documentation Updates
src/Testcontainers/Builders/IContainerBuilder\2.cs`
Updated <summary> tags for both WithCommand overloads to correctly describe them as appending rather than overriding. Expanded <remarks> to clarify composition behavior using AppendEnumerable<T> and OverwriteEnumerable<T>, and added link to external "Composing command arguments" documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Whiskers twitching with delight,
Documentation set just right!
No override, but append with care,
Command arguments now crystal clear!
Truth shall guide the developer's way. 🌟

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: extending documentation for the WithCommand(params string[]) method.
Description check ✅ Passed The description includes the mandatory 'What does this PR do?' section but lacks a substantive explanation for 'Why is it important?' (marked with a dash). The related issue #1682 is properly linked.
Linked Issues check ✅ Passed The PR directly addresses issue #1682 by updating XML documentation to clarify that WithCommand(params string[]) appends rather than overrides command arguments, matching the issue's stated objective.
Out of Scope Changes check ✅ Passed The changes are limited to XML documentation updates for the WithCommand method interface in IContainerBuilder, staying within the scope defined by issue #1682.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/update-with-command-api-doc

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Docs, docs, docs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The XML documentation for WithCommand is wrong/misleading

1 participant