Escape literal brackets in CLI and runner docs

[leynos]

Summary

• escape Build command's default indicator so rustdoc treats it as text
• remove unresolved link to main in runner docs to avoid rustdoc warnings

Testing

• cargo doc
• make fmt
• make check-fmt
• make lint
• make test

---

https://chatgpt.com/codex/tasks/task_e_689a9ae64e388322a034ca5fd44211df

Summary by Sourcery

Escape literal brackets in documentation comments and remove an unresolved link to avoid rustdoc warnings

Documentation:

• Escape default command indicator brackets in the CLI docs so rustdoc treats them as literal text
• Remove unresolved link to main in runner documentation to prevent rustdoc warnings

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR refines rustdoc comments to prevent warnings by escaping literal brackets in the CLI docs and removing an unresolved link in the runner docs.

File-Level Changes

Change	Details	Files
Escape literal brackets in CLI documentation	Escape '[' and ']' around 'default' in the Build command doc comment	src/cli.rs
Remove unresolved rustdoc link to main	Replace link annotation [main] with inline code main in module doc	src/runner.rs

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Summary by CodeRabbit

• Documentation
  • Refined CLI help text for the Build command: square brackets are now properly escaped, improving how the default indicator is rendered in help output.
  • Improved inline code formatting in runner documentation for clearer readability.
  • These updates affect documentation and presentation only; no changes to behaviour, commands, or options.

Walkthrough

Update doc comments only: escape square brackets around “default” in CLI help text and replace an intra-doc link with inline code in runner module. No code, API, or behaviour changes.

Changes

Cohort / File(s)	Summary
Documentation formatting updates src/cli.rs, src/runner.rs	Escape “[default]” as \[default\] in CLI command doc; replace [main] intra-doc link with inline main in runner module-level docs. No logic or API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• Clarify doc links #112: Apply identical doc-only edits in cli.rs and runner.rs (escape “default”, replace [main] with main).
• Fix CLI docs snippet formatting #24: Adjust CLI Commands enum doc formatting similarly to this PR.

Poem

Brackets tamed, the help now gleams,
A tidy tweak in doc-string streams.
No gears were turned, no bolts made tight,
Just clearer notes to guide the night.
Small strokes, neat prose—ship it right.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 01c2ac6 and fe9ba0b.

📒 Files selected for processing (2)

• src/cli.rs (1 hunks)
• src/runner.rs (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rs

⚙️ CodeRabbit Configuration File

**/*.rs: * Seek to keep the cyclomatic complexity of functions no more than 12.

• Adhere to single responsibility and CQRS

• Place function attributes after doc comments.

• Do not use return in single-line functions.

• Move conditionals with >2 branches into a predicate function.

• Avoid unsafe unless absolutely necessary.

• Every module must begin with a //! doc comment that explains the module's purpose and utility.

• Comments and docs must follow en-GB-oxendict (-ize / -our) spelling and grammar

• Lints must not be silenced except as a last resort.

  • #[allow] is forbidden.
  • Only narrowly scoped #[expect(lint, reason = "...")] is allowed.
  • No lint groups, no blanket or file-wide suppression.
  • Include FIXME: with link if a fix is expected.

• Where code is only used by specific features, it must be conditionally compiled or a conditional expectation for unused_code applied.

• Use rstest fixtures for shared setup and to avoid repetition between tests.

• Replace duplicated tests with #[rstest(...)] parameterised cases.

• Prefer mockall for mocks/stubs.

• Prefer .expect() over .unwrap()

• Ensure that any API or behavioural changes are reflected in the documentation in docs/

• Ensure that any completed roadmap steps are recorded in the appropriate roadmap in docs/

• Files must not exceed 400 lines in length

  • Large modules must be decomposed
  • Long match statements or dispatch tables should be decomposed by domain and collocated with targets
  • Large blocks of inline data (e.g., test fixtures, constants or templates) must be moved to external files and inlined at compile-time or loaded at run-time.

Files:

• src/cli.rs
• src/runner.rs

🔍 MCP Research (1 server)

Deepwiki:

• Document [Command Line Interface]: The CLI's Commands enum makes Build the default when no subcommand is provided; the Build variant carries targets: Vec used to select targets to build ([src/cli.rs:68-75], [src/cli.rs:81-85]).
• Document [Command Line Interface]: The parse_jobs validation enforces jobs are parsed as usize and constrained to 1..=MAX_JOBS (64) with descriptive errors for invalid input ([src/cli.rs:9-21], [src/cli.rs:35-37]).
• Document [Overview / Architecture / Runner]: runner.rs implements execution orchestration that compiles the manifest, generates the IR, and delegates actual build execution to the Ninja subprocess (ninja invocation / streaming output), i.e., runner is the stage that bridges CLI to ninja execution ([src/runner.rs:6-23], [docs/netsuke-design.md:73-79])

🔇 Additional comments (2)

src/runner.rs (1)

3-3: Documentation formatting improvement looks good.

The change from [main] to inline code formatting main removes the unresolved rustdoc link warning whilst maintaining readability.

src/cli.rs (1)

97-97: Bracket escaping correctly implemented.

The change from [default] to \[default\] properly escapes the literal brackets so rustdoc treats them as text rather than attempting to resolve them as a link. This aligns with the PR objective to eliminate rustdoc warnings.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch codex/fix-rustdoc-comment-for-build-variant

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[greptile-apps]

_{2 files reviewed, no comments}

_{Edit Code Review Bot Settings | Greptile}

[sourcery-ai]

Hey @leynos - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[leynos]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[github-actions]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.