Improve docstring

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Henry Mercer 2025-05-14 15:21:38 +01:00 committed by GitHub
parent f7ab654551
commit 15f19ac220
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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,