Conversation
✅ Deploy Preview for biomejs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThe "Ignore Code" documentation section in the formatter guide received a structural update. A new subsection for ignoring entire files was introduced, detailing the use of the Pre-merge checks✅ Passed checks (2 passed)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/content/docs/formatter/index.mdx (2)
99-101: Consider streamlining the introductory flow.The transition from "at the top of the file:" to "For example, in JavaScript:" feels slightly redundant. You might merge these into a single introduction.
🔎 Suggested refinement
-You can suppress (ignore) the formatter for an entire file by using the `biome-ignore-all format: reason` comment **at the top of the file**: - -For example, in JavaScript: +You can suppress (ignore) the formatter for an entire file by using the `biome-ignore-all format: reason` comment **at the top of the file**. For example, in JavaScript:
103-124: Consider simplifying the example by removing redundancy.The example shows two nearly identical expressions (
expr1andexpr2). Since both demonstrate the same behaviour, a single expression would suffice whilst keeping the documentation concise.🔎 Suggested simplification
```js title="example.js" // biome-ignore-all format: generated file const expr1 = [ (2 * n) / (r - l), 0, (r + l) / (r - l), -1, 0, ]; - - -const expr2 = - [ - (2 * n) / (r - l), - 0, - (r + l) / (r - l), - -1, - 0, - ];</details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: Path: .coderabbit.yaml **Review profile**: CHILL **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between ef0b84a35df315ded9d97639e998b1454439ec19 and 5bc9bda6195cd8d1a2ba23c2a32b2b1886d0a8a8. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `src/content/docs/formatter/index.mdx` </details> <details> <summary>⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)</summary> * GitHub Check: Redirect rules - biomejs * GitHub Check: Header rules - biomejs * GitHub Check: Pages changed - biomejs * GitHub Check: test </details> <details> <summary>🔇 Additional comments (2)</summary><blockquote> <details> <summary>src/content/docs/formatter/index.mdx (2)</summary><blockquote> `126-129`: **Documentation reads well.** The node-level suppression section is clear. The term "node" is used appropriately, and the example provides sufficient context for understanding. --- `134-157`: **Excellent example demonstrating node-level suppression.** The example clearly shows how to suppress formatting for a specific code block whilst maintaining readability. The comment rationale is practical and helps users understand appropriate use cases. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Summary
Part of biomejs/biome#8695