Skip to content

Fix incorrect CLI flag in auto_memory_wrapper README#1692

Merged
rapids-bot[bot] merged 3 commits intoNVIDIA:release/1.5from
ericevans-nv:fix/auto-memory-wrapper-readme-commands
Mar 2, 2026
Merged

Fix incorrect CLI flag in auto_memory_wrapper README#1692
rapids-bot[bot] merged 3 commits intoNVIDIA:release/1.5from
ericevans-nv:fix/auto-memory-wrapper-readme-commands

Conversation

@ericevans-nv
Copy link
Contributor

@ericevans-nv ericevans-nv commented Mar 1, 2026

Description

The auto_memory_wrapper README uses --config in the nat run commands, but the correct
CLI flag is --config_file. This was a pre-existing issue from the original contribution.

By Submitting this PR I confirm:

  • I am familiar with the Contributing Guidelines.
  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
    • Any contribution which contains commits that are not Signed-Off will not be accepted.
  • When the PR is ready for review, new or existing tests cover these changes.
  • When the PR is ready for review, the documentation is up to date with these changes.

Summary by CodeRabbit

  • Documentation
    • Updated CLI parameter examples in documentation to reflect the new parameter naming convention.

Replace --config with --config_file in nat run commands.

Signed-off-by: Eric Evans <194135482+ericevans-nv@users.noreply.github.com>
@ericevans-nv ericevans-nv requested a review from a team as a code owner March 1, 2026 20:05
@coderabbitai
Copy link

coderabbitai bot commented Mar 1, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7f7b63b and 66c4a9d.

📒 Files selected for processing (1)
  • examples/agents/auto_memory_wrapper/README.md

Walkthrough

Documentation update in the auto memory wrapper README, replacing CLI flag references from --config to --config_file across three code example blocks to align with the current parameter naming.

Changes

Cohort / File(s) Summary
Documentation Updates
examples/agents/auto_memory_wrapper/README.md
Updated CLI flag usage in code examples from --config to --config_file (3 occurrences across README blocks).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely describes the main change: fixing an incorrect CLI flag (--config to --config_file) in the auto_memory_wrapper README documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

@ericevans-nv ericevans-nv self-assigned this Mar 1, 2026
@ericevans-nv ericevans-nv added improvement Improvement to existing functionality non-breaking Non-breaking change labels Mar 1, 2026
@ericevans-nv
Copy link
Contributor Author

/merge

@rapids-bot rapids-bot bot merged commit 2dc253c into NVIDIA:release/1.5 Mar 2, 2026
17 checks passed
Charlie-Yi-2002 pushed a commit to Charlie-Yi-2002/NeMo-Agent-Toolkit that referenced this pull request Mar 5, 2026
The auto_memory_wrapper README uses `--config` in the `nat run` commands, but the correct
CLI flag is `--config_file`. This was a pre-existing issue from the original contribution.

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing/index.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.



## Summary by CodeRabbit

* **Documentation**
  * Updated CLI parameter examples in documentation to reflect the new parameter naming convention.

Authors:
  - Eric Evans II (https://github.com/ericevans-nv)
  - Will Killian (https://github.com/willkill07)

Approvers:
  - Will Killian (https://github.com/willkill07)

URL: NVIDIA#1692
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improvement to existing functionality non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants