Skip to content

docs: update deprecated flags in muxt-complete.md#52

Merged
crhntr merged 1 commit intomainfrom
docs/fix-flags
Dec 6, 2025
Merged

docs: update deprecated flags in muxt-complete.md#52
crhntr merged 1 commit intomainfrom
docs/fix-flags

Conversation

@crhntr
Copy link
Copy Markdown
Member

@crhntr crhntr commented Dec 6, 2025

Forgot to update the docs when I made the change.

- --find-receiver-type → --use-receiver-type
- --find-receiver-type-package → --use-receiver-type-package
- --logger → --output-routes-func-with-logger-param
- --path-prefix → --output-routes-func-with-path-prefix-param

- --find-receiver-type → --use-receiver-type
- --logger → --output-routes-func-with-logger-param
- --find-receiver-type → --use-receiver-type
- --find-receiver-type → --use-receiver-type
- --find-receiver-type-package → --use-receiver-type-package
- --find-receiver-type → --use-receiver-type
- --find-templates-variable → --use-templates-variable
- --find-receiver-type → --use-receiver-type
@claude
Copy link
Copy Markdown

claude Bot commented Dec 6, 2025

Pull Request Review

Thank you for updating the deprecated flags in the documentation! This is an important consistency improvement.

✅ Code Quality & Best Practices

Excellent work on:

  • Consistent replacement of deprecated flags across all 6 modified documentation files
  • Accurate flag name updates following the new naming conventions:
    • --find-receiver-type--use-receiver-type
    • --find-receiver-type-package--use-receiver-type-package
    • --find-templates-variable--use-templates-variable
    • --logger--output-routes-func-with-logger-param
    • --path-prefix--output-routes-func-with-path-prefix-param
  • The changes are documentation-only, so no runtime risk
  • All 28 additions and 28 deletions are straightforward flag replacements

🐛 Issue Found

Missing Updates in README.md:

The main README.md file still contains the deprecated --receiver-type flag in two locations:

  • Line 42: Run \muxt generate --receiver-type=Server` to generate HTTP handlers.`
  • Line 81: //go:generate muxt generate --receiver-type=Server

These should be updated to use --use-receiver-type=Server to be consistent with the rest of the documentation.

According to docs/reference/cli.md:92, --receiver-type is deprecated in favor of --use-receiver-type.

📊 Test Coverage

N/A - Documentation-only changes

🔒 Security Concerns

None - Documentation changes only

⚡ Performance Considerations

None - Documentation changes only

📝 Recommendation

Action Required: Please update README.md to replace the deprecated --receiver-type flag with --use-receiver-type for consistency with this PR's scope.

Once that's addressed, this PR will be ready to merge. Great attention to detail on updating all the doc files comprehensively!

@crhntr crhntr merged commit 5e554a2 into main Dec 6, 2025
2 checks passed
@crhntr crhntr deleted the docs/fix-flags branch December 6, 2025 08:26
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