docs: fix --code_review flag typo in usage tutorials (--code_review -> --code-review) - #2122
Closed
latent-9 wants to merge 1 commit into
Closed
docs: fix --code_review flag typo in usage tutorials (--code_review -> --code-review)#2122latent-9 wants to merge 1 commit into
latent-9 wants to merge 1 commit into
Conversation
The CLI example uses --code_review, but the Typer option registers as --code-review (from the code_review parameter in metagpt/software_company.py). Click rejects --code_review with 'No such option'. The --help output shown lower in the same docs already lists --code-review. Fixes usage.md and usage_cn.md.
Author
|
Closing this on my end to keep my open PRs tidy. Feel free to reopen if it is still useful. Thanks for the project. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The startup CLI example in the usage tutorials passes
--code_review(underscore):But the option is registered as
--code-review. It comes from thecode_reviewparameter inmetagpt/software_company.py(code_review: bool = typer.Option(default=True, ...)), and Typer mapscode_reviewto the option string--code-review. Click does exact long-option matching, so--code_reviewfails withError: No such option: --code_review.The auto-generated
--helpoutput shown further down in the same docs already lists the correct--code-review/--no-code-review, and the neighboring--no-implementexample uses a hyphen too — only this line is wrong.Fixes both
docs/tutorial/usage.mdanddocs/tutorial/usage_cn.md. Docs-only, no functional change.