Skip to content

Commit 397c8a3

Browse files
feat: add documentation for Get-TestItemsFromFolder function to improve clarity and usage
1 parent c23444d commit 397c8a3

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

scripts/main.ps1

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,24 @@ process {
230230
}
231231
Write-Host "Tests found at [$testsPath]"
232232

233+
234+
<#
235+
.SYNOPSIS
236+
Retrieves test items from a specified folder.
237+
238+
.DESCRIPTION
239+
Searches for test configuration, container, or test script files within the specified folder.
240+
241+
.OUTPUTS
242+
System.IO.FileInfo[]
243+
Returns an array of FileInfo objects representing the test items found.
244+
#>
233245
function Get-TestItemsFromFolder {
234-
param ([string]$FolderPath)
246+
[CmdletBinding()]
247+
param (
248+
# The path to the folder containing test items.
249+
[string]$FolderPath
250+
)
235251

236252
$configFiles = Get-ChildItem -Path $FolderPath -File -Filter '*.Configuration.ps1'
237253
if ($configFiles.Count -eq 1) {

0 commit comments

Comments
 (0)