Skip to content

README CLI section claims "eight subcommands" but ships nine (missing suggest)#199

Open
YuuGR1337 wants to merge 1 commit into
dgenio:mainfrom
YuuGR1337:fix/issue-190
Open

README CLI section claims "eight subcommands" but ships nine (missing suggest)#199
YuuGR1337 wants to merge 1 commit into
dgenio:mainfrom
YuuGR1337:fix/issue-190

Conversation

@YuuGR1337
Copy link
Copy Markdown

Fixes #190


@YuuGR1337 YuuGR1337 requested a review from dgenio as a code owner May 22, 2026 01:02
Copy link
Copy Markdown
Owner

@dgenio dgenio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

REQUEST_CHANGES

The count fix ("eight" → "nine") is correct, but the PR does not meet either acceptance criterion from #190:

  1. Broken example block — the added line (Now for the missing \suggest` example in the code block:) is inserted inside the ```bash ` fenced block. It renders as a shell command, corrupting the README.
  2. No suggest example — the issue explicitly requires a chainweaver suggest <flow> entry in the example block with a one-line description. None was added.

Suggested fix — replace the two added lines with:

# Get improvement suggestions for a flow (CW001–CW004 families).
chainweaver suggest flows/etl.flow.yaml --tools my_pkg.tools

See inline comment for the exact location.

Comment thread README.md
Comment on lines +528 to +529

Now for the missing `suggest` example in the code block:
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker — prose inside a bash fenced block

The added line renders as a shell command inside the code block, which corrupts the example. The issue acceptance criteria require a real suggest command example following the established pattern:

# Brief description comment
chainweaver <cmd> <args>

Replace both added lines (the blank and this prose) with something like:

# Get improvement suggestions for a flow (CW001–CW004 families).
chainweaver suggest flows/etl.flow.yaml --tools my_pkg.tools

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.

README CLI section claims "eight subcommands" but ships nine (missing suggest)

2 participants