Skip to content

docs: update deprecated CLI flag references - #2135

Merged
jmartin-tech merged 1 commit into
NVIDIA:mainfrom
motodriver:docs/update-deprecated-cli-flags
Sep 3, 2026
Merged

docs: update deprecated CLI flag references#2135
jmartin-tech merged 1 commit into
NVIDIA:mainfrom
motodriver:docs/update-deprecated-cli-flags

Conversation

@motodriver

Copy link
Copy Markdown
Contributor

Summary

  • replace user-facing --model_type and --model_name references with --target_type and --target_name
  • replace deprecated probe-selection examples with --spec probes.* across the README and generator/translation docs
  • add a regression test that scans user documentation for deprecated CLI flags while preserving intentional references in CLI and migration documentation

Related to #2131. A repository collaborator confirmed in the issue that stray references to the deprecated flags remained and could be updated.

Duplicate-work check

Before opening this PR, I searched open PRs for both 2131 in:body and deprecated CLI flags documentation. Neither search returned an existing PR addressing this work.

Verification

  • env -u PYTHONHOME -u PYTHONPATH .venv/bin/pytest tests/test_docs.py -q — 683 passed
  • From docs/source: env -u PYTHONHOME -u PYTHONPATH ../../.venv/bin/python -m sphinx -T -E -b html -d _build/doctrees -D language=en ./ html — build succeeded
  • git diff --check origin/main...HEAD — passed
  • Verified the changed examples use current target and spec syntax
  • Verified intentional deprecated-flag references in cliref.rst and configurable.rst remain allowed

AI assistance and human review

AI assistance from TRAE was used for repository search, drafting the edits, and running verification. I reviewed every changed line, understand the change end-to-end, and can defend it. The commit includes both Assisted-by: TRAE and my DCO Signed-off-by trailer.

Assisted-by: TRAE
Signed-off-by: 电车司机小李 <39351936+motodriver@users.noreply.github.com>
@jmartin-tech
jmartin-tech merged commit 895f643 into NVIDIA:main Sep 3, 2026
17 checks passed
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.

Documentation: REST generator configuration broken in v0.16 — CLI flags changed without docs update

2 participants