From 905fa68715f82d92a5fdf18c952e5e6226ff2383 Mon Sep 17 00:00:00 2001
From: Vladimir Vagaytsev <vladimir.vagaitsev@gmail.com>
Date: Mon, 17 Jun 2024 13:29:04 +0200
Subject: [PATCH] chore: amend some comments

---
 core/src/vcs/git-repo.ts | 4 ++--
 core/src/vcs/vcs.ts      | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/core/src/vcs/git-repo.ts b/core/src/vcs/git-repo.ts
index 80984fcc58..d497d27e8b 100644
--- a/core/src/vcs/git-repo.ts
+++ b/core/src/vcs/git-repo.ts
@@ -45,7 +45,7 @@ const getIncludeExcludeFiles: IncludeExcludeFilesHandler<GitRepoGetFilesParams,
   // Make sure action config is not mutated.
   let exclude = !params.exclude ? [] : [...params.exclude]
 
-  // Do the same normalization of the excluded paths like in `GitHandler`.
+  // Do the same normalization of the excluded paths like in "subtree" scanning mode.
   // This might be redundant because the non-normalized paths will be handled by `augmentGlobs` below.
   // But this brings no harm and makes the implementation more clear.
   exclude = exclude.map(normalize)
@@ -90,7 +90,7 @@ export class GitRepoHandler extends AbstractGitHandler {
   }
 
   /**
-   * This has the same signature as the GitHandler super class method but instead of scanning the individual directory
+   * This has the same signature as the `GitSubTreeHandler` class method but instead of scanning the individual directory
    * path directly, we scan the entire enclosing git repository, cache that file list and then filter down to the
    * sub-path. This results in far fewer git process calls but in turn collects more data in memory.
    */
diff --git a/core/src/vcs/vcs.ts b/core/src/vcs/vcs.ts
index 45bd9c1913..1968efa28c 100644
--- a/core/src/vcs/vcs.ts
+++ b/core/src/vcs/vcs.ts
@@ -470,7 +470,7 @@ export function describeConfig(config: ModuleConfig | BaseActionConfig): ActionD
  * Checks if the {@code subPathCandidate} is a sub-path of {@code basePath}.
  * Sub-path means that a candidate must be located inside a reference path.
  *
- * Both {@basePath} and {@ subPathCandidate} must be absolute paths
+ * Both {@code basePath} and {@code subPathCandidate} must be absolute paths
  *
  * @param basePath the reference path (absolute)
  * @param subPathCandidate the path to be checked (absolute)