Conversation
Reviewer's GuideThis PR standardizes markdown formatting across README.md to satisfy linting rules (wrapping, list indentation, spacing) and restructures the CLI snippet in docs/netsuke-design.md with clearer line breaks and proper indentation. Class diagram for updated CLI struct and Commands enum in documentationclassDiagram
class Cli {
+PathBuf file
+Option<usize> jobs
+Option<Commands> command
}
class Commands {
}
Commands <|-- Build
Commands <|-- Clean
Commands <|-- Graph
class Build {
+Vec<String> targets
}
class Clean {
}
class Graph {
}
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Warning Rate limit exceeded@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 50 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (2)
Summary by CodeRabbit
WalkthroughApply stylistic and formatting improvements to the Changes
Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @leynos - I've reviewed your changes - here's some feedback:
- In the Quick Example section of README.md the code fence is using four backticks (````) instead of three, which may break markdown rendering.
- In docs/netsuke-design.md, the
Clistruct andCommandsenum braces and indentation could be aligned more consistently (e.g. opening brace placement and field indentation) to match the project's Rust style conventions.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the Quick Example section of README.md the code fence is using four backticks (````) instead of three, which may break markdown rendering.
- In docs/netsuke-design.md, the `Cli` struct and `Commands` enum braces and indentation could be aligned more consistently (e.g. opening brace placement and field indentation) to match the project's Rust style conventions.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
README.md(7 hunks)docs/netsuke-design.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.md
Instructions used from:
Sources:
📄 CodeRabbit Inference Engine
- AGENTS.md
⚙️ CodeRabbit Configuration File
docs/**/*.md
Instructions used from:
Sources:
📄 CodeRabbit Inference Engine
- AGENTS.md
🪛 LanguageTool
README.md
[uncategorized] ~84-~84: Loose punctuation mark.
Context: ... ``` Targets can also define: - deps: explicit dependencies - `order_only_dep...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~175-~175: Make sure that the adjective ‘small’ is correct. Possibly, it should be an adverb (typically ~ly) that modifies ‘carved’. Possibly, it should be the first word in a compound adjective (hyphenated adjective). Possibly, it is correct.
Context: ... ## Why “Netsuke”? A netsuke is a small carved object used to fasten things securely t...
(ADVERB_OR_HYPHENATED_ADJECTIVE)
[style] ~176-~176: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...It’s not the sword. It’s not the pouch. It’s the thing that connects them. That’s...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[locale-violation] ~181-~181: License must be spelled with a “c” when used as a noun in British English. Use “licence”.
Context: ...ent and the tool that gets it done. ## License [ISC](https://opensource.org/licenses/...
(LICENCE_LICENSE_NOUN_SINGULAR)
| /// Remove build artefacts and intermediate files. Clean {}, /// Display | ||
| the build dependency graph in DOT format for visualisation. Graph {}, } | ||
| ``` |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Restore one-variant-per-line formatting in code snippet.
The doc comment and variant now share a line, harming readability and exceeding
the 120-column guideline for code blocks.
- /// Remove build artefacts and intermediate files. Clean {}, /// Display
- the build dependency graph in DOT format for visualisation. Graph {}, }
+ /// Remove build artefacts and intermediate files.
+ Clean {},
+
+ /// Display the build dependency graph in DOT format for visualisation.
+ Graph {},
+}📝 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.
| /// Remove build artefacts and intermediate files. Clean {}, /// Display | |
| the build dependency graph in DOT format for visualisation. Graph {}, } | |
| ``` | |
| /// Remove build artefacts and intermediate files. | |
| Clean {}, | |
| /// Display the build dependency graph in DOT format for visualisation. | |
| Graph {}, | |
| } |
🤖 Prompt for AI Agents
In docs/netsuke-design.md around lines 1241 to 1243, the code snippet has the
doc comment and variant on the same line, which reduces readability and exceeds
the 120-column limit. Separate the doc comment and the variant onto individual
lines to restore one-variant-per-line formatting and improve clarity within the
code block.
leynos
force-pushed
the
codex/fix-formatting-of-rust-cli-snippet
branch
from
52c5950 to
f7312c1
Compare
1 participant
Summary
netsuke-design.mdREADME.mdto satisfy markdown lintingTesting
make lintmake testmake markdownlintmake nixiehttps://chatgpt.com/codex/tasks/task_e_687afe9608088322a0efd61b5c021746
Summary by Sourcery
Fix documentation formatting issues across the repository
Documentation: