Skip to content

docs: add run subcommand to contributor guide examples - #1033

Open
original4422 wants to merge 1 commit into
modelscope:mainfrom
original4422:docs/fix-contributor-guide-run-command
Open

original4422 wants to merge 1 commit into
modelscope:mainfrom
original4422:docs/fix-contributor-guide-run-command

Conversation

@original4422

Copy link
Copy Markdown

Change Summary

Add the required run subcommand to both local-directory and ModelScope-repository examples in the English and Chinese contributor guides:

-ms-agent --config local-dir --trust_remote_code true
+ms-agent run --config local-dir --trust_remote_code true

Related issue number

Directly discovered documentation defect; no issue number.

Evidence

  • Before: all four documented examples exit with code 2 (invalid choice: local-dir / group/model-id) in the original CLI entrypoint.
  • After: all four corrected examples dispatch RunCMD with the same config and trust arguments. Only RunCMD.execute was intercepted, following the existing entrypoint tests; model/workflow execution was outside this check.
  • python -m pytest -q tests/cli/test_cli_entry.py: 4 passed. Applicable pinned Markdown whitespace, EOF, conflict and line-ending hooks plus git diff --check pass.

Merge Danger

Door: two-way. Blast Radius: documentation. Four example lines across two language pages.

Checklist

  • The pull request title is a good summary of the changes - it will be used in the changelog
  • Unit tests for the changes exist (the existing CLI entrypoint controls pass; document argv was checked separately)
  • Run pre-commit install and pre-commit run --all-files before git commit, and passed lint check. (Only applicable pinned hooks were run for these two Markdown files.)
  • Documentation reflects the changes where applicable

This branch has not been deployed

No deployments
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