Reorder arguments in table-repair command syntax

[zaidshabbir25]

Current help some switch ordering issues. Fix the ordering.

[coderabbitai]

📝 Walkthrough

Walkthrough

The table-repair command documentation was updated to reorder its syntax, moving the cluster name and table name arguments from initial positions to the end, after the --diff-file option and other flags. Help text and usage examples were adjusted accordingly.

Changes

Cohort / File(s)	Summary
Documentation Updates docs/commands/repair/table-repair.md	Reordered command syntax to place cluster_name and schema.table_name arguments after --diff-file and optional flags. Updated help text descriptions and adjusted example usage to reflect the new argument positioning. Minor formatting adjustments to options section presentation.

Poem

🐰 A rabbit hops through docs with glee,
Rearranging arguments, one, two, three!
Cluster names and tables dance to the right,
After --diff-file flags, they're set just right! 📚✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The pull request title directly summarizes the main change: reordering arguments in the table-repair command syntax, which matches the documentation updates shown in the changeset.
Description check	✅ Passed	The description references fixing switch ordering issues, which is related to the changeset involving reordering command arguments, though it contains a minor typo ('some' should likely be 'some' or 'has').
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

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/commands/repair/table-repair.md`:
- Line 8: Update the usage syntax to match the documented optionality: if
cluster_name is optional and defaults to default_cluster in ace.yaml, change the
command usage line "./ace table-repair --diff-file=<diff_file>
[--source-of-truth=<node>] [options] <cluster_name> <schema.table_name>" to use
square brackets around cluster_name ("[<cluster_name>]") and add a brief note
that it defaults to default_cluster from ace.yaml; alternatively, if
cluster_name is required, change the description that currently says "Optional"
to "Required." Locate the usage string and the descriptive line in
table-repair.md (the "./ace table-repair ..." line and the cluster_name
description) and make the corresponding edit so syntax and description are
consistent.

🧹 Nitpick comments (1)

docs/commands/repair/table-repair.md (1)

13-13: Fix nested bullet formatting.

The double dash - - creates unusual nested formatting. This should likely be a single - to match the other bullet points in this section.

♻️ Proposed formatting fix

-- - `cluster_name`: Name of the cluster. Optional. Overrides `default_cluster` in `ace.yaml` if specified.
+- `cluster_name`: Name of the cluster. Optional. Overrides `default_cluster` in `ace.yaml` if specified.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Syntax inconsistency: cluster_name shown as required but described as optional.

The syntax shows <cluster_name> without square brackets (indicating it's required), but line 13 describes it as "Optional." If cluster_name is indeed optional and can default to default_cluster from ace.yaml, the syntax should use [<cluster_name>] with square brackets.

📝 Proposed fix if cluster_name is optional

-./ace table-repair --diff-file=<diff_file> [--source-of-truth=<node>] [options] <cluster_name> <schema.table_name>
+./ace table-repair --diff-file=<diff_file> [--source-of-truth=<node>] [options] [<cluster_name>] <schema.table_name>

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	./ace table-repair --diff-file=<diff_file> [--source-of-truth=<node>] [options] <cluster_name> <schema.table_name>
	./ace table-repair --diff-file=<diff_file> [--source-of-truth=<node>] [options] [<cluster_name>] <schema.table_name>

🤖 Prompt for AI Agents

In `@docs/commands/repair/table-repair.md` at line 8, Update the usage syntax to
match the documented optionality: if cluster_name is optional and defaults to
default_cluster in ace.yaml, change the command usage line "./ace table-repair
--diff-file=<diff_file> [--source-of-truth=<node>] [options] <cluster_name>
<schema.table_name>" to use square brackets around cluster_name
("[<cluster_name>]") and add a brief note that it defaults to default_cluster
from ace.yaml; alternatively, if cluster_name is required, change the
description that currently says "Optional" to "Required." Locate the usage
string and the descriptive line in table-repair.md (the "./ace table-repair ..."
line and the cluster_name description) and make the corresponding edit so syntax
and description are consistent.