Skip to content

Commit bb0ebcf

Browse files
committed
Remove lengthy comments - code should be readable without them
1 parent 24e4f18 commit bb0ebcf

1 file changed

Lines changed: 0 additions & 71 deletions

File tree

Tools/Modules/YamlCreate/YamlCreate.GitHub/YamlCreate.GitHub.psm1

Lines changed: 0 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -141,23 +141,6 @@ function Invoke-GitHubRequest {
141141
}
142142
}
143143

144-
<#
145-
.SYNOPSIS
146-
Gets the URL of a git remote.
147-
148-
.DESCRIPTION
149-
Gets the URL for a specified git remote by name.
150-
151-
.PARAMETER RemoteName
152-
The name of the git remote (e.g., 'origin', 'upstream').
153-
154-
.OUTPUTS
155-
System.String - The URL of the remote, or $null if the remote does not exist.
156-
157-
.EXAMPLE
158-
PS> Get-Remote -RemoteName upstream
159-
https://github.com/microsoft/winget-pkgs.git
160-
#>
161144
function Get-Remote {
162145
param(
163146
[Parameter(Mandatory = $true)]
@@ -175,26 +158,6 @@ function Get-Remote {
175158
}
176159
}
177160

178-
<#
179-
.SYNOPSIS
180-
Sets or adds a git remote.
181-
182-
.DESCRIPTION
183-
Sets the URL for an existing git remote, or adds a new remote if it doesn't exist.
184-
185-
.PARAMETER RemoteName
186-
The name of the git remote (e.g., 'origin', 'upstream').
187-
188-
.PARAMETER Url
189-
The URL to set for the remote.
190-
191-
.OUTPUTS
192-
System.Boolean - $true if successful, $false otherwise.
193-
194-
.EXAMPLE
195-
PS> Set-Remote -RemoteName upstream -Url 'https://github.com/microsoft/winget-pkgs.git'
196-
True
197-
#>
198161
function Set-Remote {
199162
param(
200163
[Parameter(Mandatory = $true)]
@@ -217,25 +180,6 @@ function Set-Remote {
217180
}
218181
}
219182

220-
<#
221-
.SYNOPSIS
222-
Finds open pull requests for a package version.
223-
224-
.DESCRIPTION
225-
Queries the GitHub API for open pull requests matching the specified package identifier and version.
226-
227-
.PARAMETER PackageIdentifier
228-
The package identifier (e.g., 'Microsoft.WindowsTerminal').
229-
230-
.PARAMETER PackageVersion
231-
The version of the package (e.g., '1.18.0').
232-
233-
.OUTPUTS
234-
System.Object - The PR API response object if found, or $null if none found.
235-
236-
.EXAMPLE
237-
PS> Find-PullRequest -PackageIdentifier 'Microsoft.WindowsTerminal' -PackageVersion '1.18.0'
238-
#>
239183
function Find-PullRequest {
240184
param(
241185
[Parameter(Mandatory = $true)]
@@ -264,21 +208,6 @@ function Find-PullRequest {
264208
}
265209
}
266210

267-
<#
268-
.SYNOPSIS
269-
Gets the PR template content from the upstream remote.
270-
271-
.DESCRIPTION
272-
Fetches the PULL_REQUEST_TEMPLATE.md content from the upstream remote repository.
273-
If the template cannot be fetched, a warning is issued but the function continues.
274-
275-
.OUTPUTS
276-
System.String - The template content if available, or $null if unavailable.
277-
278-
.EXAMPLE
279-
PS> Get-PrTemplate
280-
# PR Template Content...
281-
#>
282211
function Get-PrTemplate {
283212
try {
284213
$contentsApiUrl = '/repos/microsoft/winget-pkgs/contents/.github/PULL_REQUEST_TEMPLATE.md?ref=master'

0 commit comments

Comments
 (0)