Skip to content

Remove the check in HelpGeneration #22244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Nickcandy merged 1 commit into from
Jul 5, 2023
Merged

Remove the check in HelpGeneration #22244

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 0 additions & 35 deletions tools/HelpGeneration/HelpGeneration.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,41 +177,6 @@ function Test-AzMarkdownHelp
$fileErrors += "No description found"
}
}
"## EXAMPLES"
{
# Move the index to the start of the PowerShell code
while (-not $content[$idx].StartsWith("``````"))
{
$idx++
if ($idx -ge $content.Length)
{
Write-Error "Could not find start of PowerShell example in file $($file.Name)"
return
}
}

# Check for the platyPS example template
#
# ```
# PS C:\> {{ Add example code here }}
# ```
#
if ($content[$idx+1] -contains "{{ Add example code here }}")
{
$fileErrors += "No examples found"
}

# Check for other missing example formats (such as empty)
#
# ```
#
# ```
#
if ([string]::IsNullOrWhiteSpace("$($content[$idx+1])"))
{
$fileErrors += "No examples found"
}
}
"@{Text=}"
{
# This case occurs when there is no description provided for a parameter
Expand Down