Skip to content

Fix CLI docs snippet formatting #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leynos merged 2 commits into from
Jul 20, 2025
Merged

Fix CLI docs snippet formatting #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43ad07b
Fix CLI snippet formatting
leynos Jul 19, 2025
f7312c1
Fix CLI docs formatting
leynos Jul 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# 🧵 Netsuke

A modern, declarative build system compiler.
YAML + Jinja in, Ninja out. Nothing more. Nothing less.
A modern, declarative build system compiler. YAML + Jinja in, Ninja out.
Nothing more. Nothing less.

## What is Netsuke?

**Netsuke** is a friendly build system that compiles structured manifests into
a Ninja build graph.
It’s not a shell-script runner, a meta-task framework, or a domain-specific CI
layer. It’s `make`, if `make` hadn’t been invented in 1977.
a Ninja build graph. It’s not a shell-script runner, a meta-task framework, or
a domain-specific CI layer. It’s `make`, if `make` hadn’t been invented in 1977.

### Key properties

Expand Down Expand Up @@ -48,7 +47,7 @@ targets:
- name: app
rule: link
sources: "{{ glob('src/*.c') | map('basename') | map('with_suffix', '.o') }}"
````
```

Yes, it’s just YAML. Yes, that’s a Jinja `foreach`. No, you don’t need to
define `.PHONY` or remember what `$@` means. This is 2025. You deserve better.
Expand Down
6 changes: 2 additions & 4 deletions docs/netsuke-design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1237,10 +1237,8 @@ enum Commands { /// Build specified targets (or default targets if none are
given) [default]. Build { /// A list of specific targets to build. targets:
Vec<String>, },

/// Remove build artifacts and intermediate files. Clean {},

/// Display the build dependency graph in DOT format for visualization.
Graph {},
/// Remove build artefacts and intermediate files. Clean {}, /// Display
the build dependency graph in DOT format for visualisation. Graph {}, }
```
Comment on lines +1240 to 1242
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jul 19, 2025

Choose a reason for hiding this comment

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

🧹 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.

Suggested change
/// 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.


*Note: The* `Build` *command is wrapped in an* `Option<Commands>` *and will be
Expand Down