docs: improve documentation of rule

biomejs · Sep 19, 2024 · bf7682e · bf7682e
1 parent 6922305
commit bf7682e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/crates/biome_js_analyze/src/lint/correctness/use_exhaustive_dependencies.rs b/crates/biome_js_analyze/src/lint/correctness/use_exhaustive_dependencies.rs
@@ -22,6 +22,8 @@ use schemars::JsonSchema;
 declare_lint_rule! {
     /// Enforce all dependencies are correctly specified in a React hook.
     ///
+    /// _This rule should be used only in **React** projects._
+    ///
     /// This rule is a port of the rule [react-hooks/exhaustive-deps](https://legacy.reactjs.org/docs/hooks-rules.html#eslint-plugin), and it's meant to target projects that uses React.
     ///
     /// If your project _doesn't_ use React (or Preact), **you shouldn't use this rule**.

diff --git a/crates/biome_js_analyze/src/lint/correctness/use_hook_at_top_level.rs b/crates/biome_js_analyze/src/lint/correctness/use_hook_at_top_level.rs
@@ -30,6 +30,8 @@ use schemars::JsonSchema;
 declare_lint_rule! {
     /// Enforce that all React hooks are being called from the Top Level component functions.
     ///
+    /// _This rule should be used only in **React** projects._
+    ///
     /// To understand why this required see https://reactjs.org/docs/hooks-rules.html#only-call-hooks-at-the-top-level
     ///
     /// ## Examples