Skip to content

Update muxt command in README for clarity#53

Merged
crhntr merged 1 commit intomainfrom
docs/fix-flags-and-add-tests-link
Dec 8, 2025
Merged

Update muxt command in README for clarity#53
crhntr merged 1 commit intomainfrom
docs/fix-flags-and-add-tests-link

Conversation

@crhntr
Copy link
Copy Markdown
Member

@crhntr crhntr commented Dec 6, 2025

Also fix the flags

Also fix the flags

Signed-off-by: Christopher Hunter <8398225+crhntr@users.noreply.github.com>
@claude
Copy link
Copy Markdown

claude Bot commented Dec 6, 2025

Pull Request Review

Summary

This PR correctly updates the README examples to use the proper flag --use-receiver-type instead of the deprecated --receiver-type, and adds a helpful reference to the command tests as additional examples.

✅ Code Quality & Best Practices

Excellent work! The changes are:

  • Accurate: The flag update from --receiver-type to --use-receiver-type is correct according to docs/reference/cli.md:91-92
  • Consistent: All three instances in the README have been updated (lines 42, 81)
  • Clear: The new examples section reference helps users discover the test fixtures as learning resources

✅ Correctness Verification

Verified against the codebase:

  • --use-receiver-type is the current canonical flag (internal/cli/commands.go:365)
  • --receiver-type is deprecated (internal/cli/commands.go:382, docs/reference/cli.md:91)
  • All documentation and test files use --use-receiver-type consistently
  • The command tests reference (./cmd/muxt/testdata) is valid and contains 50+ test examples

✅ Documentation Improvement

The addition of the test examples link is a valuable improvement:

  • Provides concrete, runnable examples for users
  • Aligns with the project's test-driven approach
  • Uses appropriate qualifying language ("were intended to be readable examples")

No Issues Found

  • Security: No security concerns (documentation-only change)
  • Performance: No performance impact (documentation-only change)
  • Test Coverage: N/A (documentation-only change)
  • Breaking Changes: None (maintains backward compatibility - old flag still works with deprecation warning)
  • Potential Bugs: None identified

Minor Observations

  1. Consistency check: All other documentation already uses --use-receiver-type, so this brings the README in line with the rest of the project
  2. User impact: Positive - helps users avoid using deprecated flags from the start

Recommendation

Approve and merge. This is a clean, focused documentation fix that improves accuracy and user experience.


🤖 Review generated with Claude Code

@crhntr crhntr merged commit 395bc45 into main Dec 8, 2025
2 checks passed
@crhntr crhntr deleted the docs/fix-flags-and-add-tests-link branch December 8, 2025 20:48
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.

1 participant