From 15f19ac220bd23b50c2fdd3b974bd443089045a8 Mon Sep 17 00:00:00 2001 From: Henry Mercer Date: Wed, 14 May 2025 15:21:38 +0100 Subject: [PATCH] Improve docstring Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- src/upload-lib.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/upload-lib.ts b/src/upload-lib.ts index a995486e0..db9d42473 100644 --- 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,