Skip to content

Commit

Permalink
chore: amend some comments
Browse files Browse the repository at this point in the history
  • Loading branch information
vvagaytsev committed Jun 17, 2024
1 parent 0315e5d commit 905fa68
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions core/src/vcs/git-repo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
*/
Expand Down
2 changes: 1 addition & 1 deletion core/src/vcs/vcs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 905fa68

Please sign in to comment.