Improve docstring

henrymercer · Copilot · web-flow · commit 15f19ac220bd · 2025-05-14T15:21:38.000+01:00
Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;
diff --git a/src/upload-lib.ts b/src/upload-lib.ts
@@ -444,8 +444,8 @@ export function readSarifFile(sarifFilePath: string): SarifFile {
   }
 }
 
-// Validates that the given file path refers to a valid SARIF file.
-// Throws an error if the file is invalid.
+// Validates the given SARIF object and throws an error if the SARIF object is invalid.
+// The file path is only used in error messages to improve clarity.
 export function validateSarifFileSchema(
   sarif: SarifFile,
   sarifFilePath: string,

Original file line number	Diff line number	Diff line change
`@@ -444,8 +444,8 @@ export function readSarifFile(sarifFilePath: string): SarifFile {`
`444`	`444`	`}`
`445`	`445`	`}`
`446`	`446`
`447`		`-// Validates that the given file path refers to a valid SARIF file.`
`448`		`-// Throws an error if the file is invalid.`
	`447`	`+// Validates the given SARIF object and throws an error if the SARIF object is invalid.`
	`448`	`+// The file path is only used in error messages to improve clarity.`
`449`	`449`	`export function validateSarifFileSchema(`
`450`	`450`	`sarif: SarifFile,`
`451`	`451`	`sarifFilePath: string,`