From 726e273f60fc720cee07820ece6a11a33af6e1d6 Mon Sep 17 00:00:00 2001
From: overlookmotel <557937+overlookmotel@users.noreply.github.com>
Date: Sat, 7 Feb 2026 10:46:25 +0000
Subject: [PATCH] docs(linter/plugins): improve JSDoc comment for
 `DiagnosticReport` (#19103)

Improve accuracy of a JSDoc comment.
---
 apps/oxlint/src-js/plugins/report.ts | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/apps/oxlint/src-js/plugins/report.ts b/apps/oxlint/src-js/plugins/report.ts
index 4a0abfa407501..9add38c30e268 100644
--- a/apps/oxlint/src-js/plugins/report.ts
+++ b/apps/oxlint/src-js/plugins/report.ts
@@ -70,8 +70,9 @@ export interface SuggestionReport {
   fixes: FixReport[];
 }
 
-// Diagnostic in form sent to Rust.
-// Actually, the `messageId` field is removed before sending to Rust.
+/**
+ * Diagnostic in form sent to Rust.
+ */
 export interface DiagnosticReport {
   message: string;
   start: number;
@@ -79,8 +80,9 @@ export interface DiagnosticReport {
   ruleIndex: number;
   fixes: FixReport[] | null;
   suggestions: SuggestionReport[] | null;
+  // Not needed on Rust side, but `RuleTester` needs it
   messageId: string | null;
-  // Only used in conformance tests
+  // Only used in conformance tests. This field is not present except in conformance build.
   loc?: LocationWithOptionalEnd | null;
 }