Skip to content

Commit

Permalink
Fix comment in YamlCreate (microsoft#147781)
Browse files Browse the repository at this point in the history
  • Loading branch information
SpecterShell authored Apr 5, 2024
1 parent be96d3f commit 2bd7969
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions Tools/YamlCreate.ps1
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Justification = 'This script is not intended to have any outputs piped')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'Preserve', Justification = 'The variable is used in a conditional but ScriptAnalyser does not recognize the scope')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '', Scope = 'Function', Target = 'Read-AppsAndFeaturesEntries',
Justification = 'Ths function is a wrapper which calls the singular Read-AppsAndFeaturesEntry as many times as necessary. It corresponds exactly to a pluralized manifest field')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '', Scope = 'Function', Target = '*Metadata',
Justification = 'Metadata is used as a mass noun and is therefore singular in the cases used in this script')]

<#
<#
.SYNOPSIS
WinGet Manifest creation helper script
.DESCRIPTION
Expand All @@ -14,8 +7,7 @@
It'll attempt to download an installer from the user-provided URL to calculate
a checksum. That checksum and the rest of the input data will be compiled into
a set of .yaml files.
file.
a set of .YAML files.
.EXAMPLE
PS C:\Projects\winget-pkgs> Get-Help .\Tools\YamlCreate.ps1 -Full
Show this script's help
Expand All @@ -28,8 +20,13 @@
.LINK
https://github.com/microsoft/winget-pkgs/blob/master/Tools/YamlCreate.ps1
#>

#Requires -Version 5
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Justification = 'This script is not intended to have any outputs piped')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'Preserve', Justification = 'The variable is used in a conditional but ScriptAnalyser does not recognize the scope')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '', Scope = 'Function', Target = 'Read-AppsAndFeaturesEntries',
Justification = 'Ths function is a wrapper which calls the singular Read-AppsAndFeaturesEntry as many times as necessary. It corresponds exactly to a pluralized manifest field')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '', Scope = 'Function', Target = '*Metadata',
Justification = 'Metadata is used as a mass noun and is therefore singular in the cases used in this script')]

Param
(
Expand Down

0 comments on commit 2bd7969

Please sign in to comment.