Skip to content

Commit

Permalink
refactor: resolve lintdoc warnings (#2440)
Browse files Browse the repository at this point in the history
  • Loading branch information
Conaclos authored Apr 14, 2024
1 parent 635493b commit 58c4b0a
Show file tree
Hide file tree
Showing 29 changed files with 89 additions and 89 deletions.
2 changes: 1 addition & 1 deletion crates/biome_cli/src/execute/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ impl Execution {
}
}

/// Based on the [mode](ExecutionMode), the function might launch a traversal of the file system
/// Based on the [mode](TraversalMode), the function might launch a traversal of the file system
/// or handles the stdin file.
pub fn execute_mode(
mut execution: Execution,
Expand Down
2 changes: 1 addition & 1 deletion crates/biome_configuration/src/javascript/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ pub enum JsxRuntime {
/// This option should only be necessary if you cannot upgrade to a React
/// version that supports the new JSX runtime. For more information about
/// the old vs. new JSX runtime, please see:
/// https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html
/// <https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html>
ReactClassic,
}

Expand Down
10 changes: 5 additions & 5 deletions crates/biome_configuration/src/linter/rules.rs
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ pub struct A11y {
#[doc = "Enforces that no distracting elements are used."]
#[serde(skip_serializing_if = "Option::is_none")]
pub no_distracting_elements: Option<RuleConfiguration<NoDistractingElements>>,
#[doc = "The scope prop should be used only on <th> elements."]
#[doc = "The scope prop should be used only on \\<th> elements."]
#[serde(skip_serializing_if = "Option::is_none")]
pub no_header_scope: Option<RuleConfiguration<NoHeaderScope>>,
#[doc = "Enforce that non-interactive ARIA roles are not assigned to interactive HTML elements."]
Expand Down Expand Up @@ -2587,7 +2587,7 @@ pub struct Nursery {
#[doc = "Disallow the use of barrel file."]
#[serde(skip_serializing_if = "Option::is_none")]
pub no_barrel_file: Option<RuleConfiguration<NoBarrelFile>>,
#[doc = "[WIP] This rule hasn't been implemented yet."]
#[doc = "WIP: This rule hasn't been implemented yet."]
#[serde(skip_serializing_if = "Option::is_none")]
pub no_color_invalid_hex: Option<RuleConfiguration<NoColorInvalidHex>>,
#[doc = "Disallow the use of console."]
Expand Down Expand Up @@ -3523,7 +3523,7 @@ pub struct Style {
#[doc = "Enforce using else if instead of nested if in else clauses."]
#[serde(skip_serializing_if = "Option::is_none")]
pub use_collapsed_else_if: Option<RuleConfiguration<UseCollapsedElseIf>>,
#[doc = "Require consistently using either T[] or Array<T>"]
#[doc = "Require consistently using either T\\[] or Array\\<T>"]
#[serde(skip_serializing_if = "Option::is_none")]
pub use_consistent_array_type: Option<RuleConfiguration<UseConsistentArrayType>>,
#[doc = "Require const declarations for variables that are never reassigned after declared."]
Expand All @@ -3547,7 +3547,7 @@ pub struct Style {
#[doc = "This rule recommends a for-of loop when in a for loop, the index used to extract an item from the iterated array."]
#[serde(skip_serializing_if = "Option::is_none")]
pub use_for_of: Option<RuleConfiguration<UseForOf>>,
#[doc = "This rule enforces the use of <>...</> over <Fragment>...</Fragment>."]
#[doc = "This rule enforces the use of \\<>...\\</> over \\<Fragment>...\\</Fragment>."]
#[serde(skip_serializing_if = "Option::is_none")]
pub use_fragment_syntax: Option<RuleConfiguration<UseFragmentSyntax>>,
#[doc = "Promotes the use of import type for types."]
Expand All @@ -3571,7 +3571,7 @@ pub struct Style {
#[doc = "Prevent extra closing tags for components without children"]
#[serde(skip_serializing_if = "Option::is_none")]
pub use_self_closing_elements: Option<RuleConfiguration<UseSelfClosingElements>>,
#[doc = "When expressing array types, this rule promotes the usage of T[] shorthand instead of Array<T>."]
#[doc = "When expressing array types, this rule promotes the usage of T\\[] shorthand instead of Array\\<T>."]
#[serde(skip_serializing_if = "Option::is_none")]
pub use_shorthand_array_type: Option<RuleConfiguration<UseShorthandArrayType>>,
#[doc = "Require assignment operator shorthand where possible."]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use biome_css_syntax::CssDeclarationOrRuleBlock;
use biome_rowan::AstNode;

declare_rule! {
/// **[WIP] This rule hasn't been implemented yet.**
/// **WIP: This rule hasn't been implemented yet.**
///
/// This is sample rule
///
Expand Down
12 changes: 6 additions & 6 deletions crates/biome_js_analyze/src/globals/javascript/language.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/// Sorted array of ES builtin
///
/// Source: https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L2-L70
/// Source: <https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L2-L70>
pub const ES_BUILTIN: &[&str; 67] = &[
"AggregateError",
"Array",
Expand Down Expand Up @@ -73,7 +73,7 @@ pub const ES_BUILTIN: &[&str; 67] = &[

/// Sorted array of ES5 builtin
///
/// Source: https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L71-L110
/// Source: <https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L71-L110>
pub const ES_5: &[&str; 38] = &[
"Array",
"Boolean",
Expand Down Expand Up @@ -117,7 +117,7 @@ pub const ES_5: &[&str; 38] = &[

/// Sorted array of ES2015 builtin
///
/// Source: https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L111-L170
/// Source: <https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L111-L170>
pub const ES_2015: &[&str; 58] = &[
"Array",
"ArrayBuffer",
Expand Down Expand Up @@ -181,7 +181,7 @@ pub const ES_2015: &[&str; 58] = &[

/// Sorted array of ES2017 builtin
///
/// Source: https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L171-L232
/// Source: <https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L171-L232>
pub const ES_2017: &[&str; 60] = &[
"Array",
"ArrayBuffer",
Expand Down Expand Up @@ -247,7 +247,7 @@ pub const ES_2017: &[&str; 60] = &[

/// Sorted array of ES2020 builtin
///
/// Source: https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L233-L298
/// Source: <https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L233-L298>
pub const ES_2020: &[&str; 64] = &[
"Array",
"ArrayBuffer",
Expand Down Expand Up @@ -317,7 +317,7 @@ pub const ES_2020: &[&str; 64] = &[

/// Sorted array of ES2021 builtin
///
/// Source: https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L299-L367
/// Source: <https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L299-L367>
pub const ES_2021: &[&str; 67] = &[
"AggregateError",
"Array",
Expand Down
6 changes: 3 additions & 3 deletions crates/biome_js_analyze/src/globals/javascript/node.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/// Sorted array of Node builtin
///
/// Source: https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L1801-L1869
/// Source: <https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L1801-L1869>
pub const BUILTIN: &[&str; 67] = &[
"AbortController",
"AbortSignal",
Expand Down Expand Up @@ -73,7 +73,7 @@ pub const BUILTIN: &[&str; 67] = &[

/// Sorted array of Node
///
/// Source: https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L1727-L1800
/// Source: <https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L1727-L1800>
pub const NODE: &[&str; 72] = &[
"AbortController",
"AbortSignal",
Expand Down Expand Up @@ -151,7 +151,7 @@ pub const NODE: &[&str; 72] = &[

/// Sorted array of CommonJs builtin
///
/// Source: https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L1870-L1875
/// Source: <https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L1870-L1875>
pub const COMMON_JS: &[&str; 4] = &["exports", "global", "module", "require"];

/// Returns `true` if `name` is a node global
Expand Down
6 changes: 3 additions & 3 deletions crates/biome_js_analyze/src/globals/javascript/web.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/// Sorted array of browser builtin
///
/// Source: https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L368-L1442
/// Source: <https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L368-L1442>
pub const BROWSER: &[&str; 1073] = &[
"AbortController",
"AbortSignal",
Expand Down Expand Up @@ -1079,7 +1079,7 @@ pub const BROWSER: &[&str; 1073] = &[

/// Sorted array of browser service worker builtin
///
/// Source: https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L2212-L2334
/// Source: <https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L2212-L2334>
pub const SERVICE_WORKER: &[&str; 121] = &[
"Blob",
"BroadcastChannel",
Expand Down Expand Up @@ -1206,7 +1206,7 @@ pub const SERVICE_WORKER: &[&str; 121] = &[

/// Sorted array of browser web worker builtin
///
/// Source: https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L1443-L1726
/// Source: <https://github.com/sindresorhus/globals/blob/9e2e2598dabdb845ff76c0c3acf5c52c812a64de/globals.json#L1443-L1726>
pub const WEB_WORKER: &[&str; 282] = &[
"AbortController",
"AbortSignal",
Expand Down
2 changes: 1 addition & 1 deletion crates/biome_js_analyze/src/globals/module/node.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/// Sorted array of Node builtin modules
///
/// Source: https://github.com/inspect-js/is-core-module/blob/8317b311856a61935d7257ad5f31f9b0cfd13b5f/core.json#L1-L158
/// Source: <https://github.com/inspect-js/is-core-module/blob/8317b311856a61935d7257ad5f31f9b0cfd13b5f/core.json#L1-L158>
pub const BUILTIN_MODULES: &[&str; 156] = &[
"_debug_agent",
"_debugger",
Expand Down
22 changes: 11 additions & 11 deletions crates/biome_js_analyze/src/globals/typescript/language.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/// Sorted array of TypeScript ES5 builtin
///
/// Source: https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es5.ts
/// Source: <https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es5.ts>
pub const ES_5: &[&str; 119] = &[
"Array",
"ArrayBuffer",
Expand Down Expand Up @@ -125,7 +125,7 @@ pub const ES_5: &[&str; 119] = &[

/// Sorted array of TypeScript ES2015 builtin
///
/// Source: https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2015.ts
/// Source: <https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2015.ts>
pub const ES_2015: &[&str; 143] = &[
"Array",
"ArrayBuffer",
Expand Down Expand Up @@ -276,7 +276,7 @@ pub const ES_6: &[&str; 143] = ES_2015;

/// Sorted array of TypeScript ES2016 builtin
///
/// Source: https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2016.ts
/// Source: <https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2016.ts>
pub const ES_2016: &[&str; 143] = &[
"Array",
"ArrayBuffer",
Expand Down Expand Up @@ -427,7 +427,7 @@ pub const ES_7: &[&str; 143] = ES_2016;

/// Sorted array of TypeScript ES2017 builtin
///
/// Source: https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2017.ts
/// Source: <https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2017.ts>
pub const ES_2017: &[&str; 146] = &[
"Array",
"ArrayBuffer",
Expand Down Expand Up @@ -579,7 +579,7 @@ pub const ES_2017: &[&str; 146] = &[

/// Sorted array of TypeScript ES2018 builtin
///
/// Source: https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2018.ts
/// Source: <https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2018.ts>
pub const ES_2018: &[&str; 152] = &[
"Array",
"ArrayBuffer",
Expand Down Expand Up @@ -737,7 +737,7 @@ pub const ES_2018: &[&str; 152] = &[

/// Sorted array of TypeScript ES2019 builtin
///
/// Source: https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2019.ts
/// Source: <https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2019.ts>
pub const ES_2019: &[&str; 153] = &[
"Array",
"ArrayBuffer",
Expand Down Expand Up @@ -896,7 +896,7 @@ pub const ES_2019: &[&str; 153] = &[

/// Sorted array of TypeScript ES2020 builtin
///
/// Source: https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2020.ts
/// Source: <https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2020.ts>
pub const ES_2020: &[&str; 163] = &[
"Array",
"ArrayBuffer",
Expand Down Expand Up @@ -1065,7 +1065,7 @@ pub const ES_2020: &[&str; 163] = &[

/// Sorted array of TypeScript ES2021 builtin
///
/// Source: https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2021.ts
/// Source: <https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2021.ts>
pub const ES_2021: &[&str; 169] = &[
"AggregateError",
"AggregateErrorConstructor",
Expand Down Expand Up @@ -1240,7 +1240,7 @@ pub const ES_2021: &[&str; 169] = &[

/// Sorted array of TypeScript ES2022 builtin
///
/// Source: https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2022.ts
/// Source: <https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es2022.ts>
pub const ES_2022: &[&str; 171] = &[
"AggregateError",
"AggregateErrorConstructor",
Expand Down Expand Up @@ -1417,7 +1417,7 @@ pub const ES_2022: &[&str; 171] = &[

/// Sorted array of TypeScript ES2023 builtin
///
/// Source: https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/esnext.ts
/// Source: <https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/esnext.ts>
pub const ES_2023: &[&str; 171] = &[
"AggregateError",
"AggregateErrorConstructor",
Expand Down Expand Up @@ -1594,7 +1594,7 @@ pub const ES_2023: &[&str; 171] = &[

/// Sorted array of TypeScript ESNext builtin
///
/// Source: https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es5.ts
/// Source: <https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/es5.ts>
pub const ES_NEXT: &[&str; 180] = &[
"AggregateError",
"AggregateErrorConstructor",
Expand Down
2 changes: 1 addition & 1 deletion crates/biome_js_analyze/src/globals/typescript/node.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/// Sorted array of TypeScript Node globals
///
/// Source: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/8279710799f3c39d5cd129cac5705b809b66022a/types/node/globals.d.ts#L17-L411
/// Source: <https://github.com/DefinitelyTyped/DefinitelyTyped/blob/8279710799f3c39d5cd129cac5705b809b66022a/types/node/globals.d.ts#L17-L411>
pub const NODE: &[&str; 42] = &[
"AbortController",
"AbortSignal",
Expand Down
4 changes: 2 additions & 2 deletions crates/biome_js_analyze/src/globals/typescript/web.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/// Sorted array of TypeScript DOM builtin
///
/// Source: https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/dom.ts
/// Source: <https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/dom.ts>
pub const DOM: &[&str; 1431] = &[
"ANGLE_instanced_arrays",
"ARIAMixin",
Expand Down Expand Up @@ -1437,7 +1437,7 @@ pub const DOM: &[&str; 1431] = &[

/// Sorted array of TypeScript Web Worker builtin
///
/// Source: https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/webworker.ts
/// Source: <https://github.com/typescript-eslint/typescript-eslint/blob/4d6d0d5950f587780dec998816d458ae4b27a513/packages/scope-manager/src/lib/webworker.ts>
pub const WEB_WORKER: &[&str; 579] = &[
"ANGLE_instanced_arrays",
"AbortController",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,6 @@ pub enum NoVoidElementsWithChildrenCause {
dangerous_prop_cause: Option<JsPropertyObjectMember>,
/// If the current element has the prop `children`
children_prop: Option<JsPropertyObjectMember>,
/// An instance of [ReactCreateElementCall]
react_create_element: ReactCreateElementCall,
},
}
Expand Down
2 changes: 1 addition & 1 deletion crates/biome_js_parser/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
//! You probably do not want to use the parser struct, unless you want to parse fragments of Js source code or make your own productions.
//! Instead use functions such as [parse_script], and [parse_module] which offer abstracted versions for parsing.
//!
//! For more finer control, use [parse](crate::parse::parse) or [parse_js_with_cache],
//! For more finer control, use [parse](crate::parse::parse()) or [parse_js_with_cache],
//!
//! Notable features of the parser are:
//! - Extremely fast parsing and lexing through the extremely fast lexer.
Expand Down
4 changes: 2 additions & 2 deletions crates/biome_js_semantic/src/events.rs
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ impl SemanticEvent {
/// example. As soon `a` is hoisted, all references of `a` are solved
/// on this node.
///
/// For a simpler way to extract [SemanticEvent] see [semantic_events] or [SemanticEventIterator].
/// For a simpler way to extract [SemanticEvent] see [semantic_events].
///
/// To use the [SemanticEventExtractor] one must push the current node, following
/// the pre-order of the tree, and must pull events until `pop` returns [None].
Expand Down Expand Up @@ -285,7 +285,7 @@ impl SemanticEventExtractor {
}
}

/// See [SemanticEvent] for a more detailed description of which events [SyntaxNode] generates.
/// See [SemanticEvent] for a more detailed description of which events [JsSyntaxNode] generates.
#[inline]
pub fn enter(&mut self, node: &JsSyntaxNode) {
// If you push a scope for a given node type, don't forget to also update `Self::leave`.
Expand Down
4 changes: 2 additions & 2 deletions crates/biome_js_semantic/src/semantic_model/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ use std::collections::hash_map::Entry;
/// For a good example on how to use it see [semantic_model].
///
/// [SemanticModelBuilder] consumes all the [SemanticEvent] and build all the
/// data necessary to build a [SemanticModelData], that is allocated with an [Arc]
/// and stored inside the [SemanticModel].
/// data necessary to build a semantic model, that is allocated with an
/// [std::sync::Arc] and stored inside the [SemanticModel].
pub struct SemanticModelBuilder {
root: AnyJsRoot,
node_by_range: FxHashMap<TextRange, JsSyntaxNode>,
Expand Down
6 changes: 3 additions & 3 deletions crates/biome_js_semantic/src/semantic_model/model.rs
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,10 @@ impl PartialEq for SemanticModelData {
impl Eq for SemanticModelData {}

/// The façade for all semantic information.
/// - Scope: [Scope]
/// - Declarations: [declaration]
/// - [Scope]
/// - Declarations
///
/// See [SemanticModelData] for more information about the internals.
/// See `SemanticModelData` for more information about the internals.
#[derive(Clone, Debug)]
pub struct SemanticModel {
pub(crate) data: Rc<SemanticModelData>,
Expand Down
10 changes: 5 additions & 5 deletions crates/biome_js_syntax/src/expr_ext.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1667,11 +1667,11 @@ impl JsCallExpression {
/// 5. The second argument has to be an [arrow function expression] or [function expression]
/// 6. Both function must have zero or one parameters
///
/// [call expression]: crate::biome_js_syntax::JsCallExpression
/// [callee]: crate::biome_js_syntax::AnyJsExpression
/// [arguments]: crate::biome_js_syntax::JsCallArgumentList
/// [arrow function expression]: crate::biome_js_syntax::JsArrowFunctionExpression
/// [function expression]: crate::biome_js_syntax::JsCallArgumentList
/// [call expression]: crate::JsCallExpression
/// [callee]: crate::AnyJsExpression
/// [arguments]: crate::JsCallArgumentList
/// [arrow function expression]: crate::JsArrowFunctionExpression
/// [function expression]: crate::JsCallArgumentList
pub fn is_test_call_expression(&self) -> SyntaxResult<bool> {
use AnyJsExpression::*;

Expand Down
Loading

0 comments on commit 58c4b0a

Please sign in to comment.