GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Style: Add period in summary doc tags by iSazonov · Pull Request #8577 · PowerShell/PowerShell

Conversation

@iSazonov

@iSazonov Ilya (iSazonov) commented Jan 1, 2019 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Collaborator

PR Summary

Style fix: Add period in summary doc tags.

PR Checklist

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Change is not breaking
  • Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
  • This PR is ready to merge and is not Work in Progress.
    • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.
  • User-facing changes
    • Not Applicable
    • OR
    • User-facing Documentation needed
      • Issue filed - Issue link:
  • Testing - New and feature
    • Not Applicable or can only be tested interactively
    • OR
    • Make sure you've added a new test if existing tests do not effectively test the code changed
      • Add [feature] if the change is significant or affects feature tests

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Ilya (iSazonov) added 15 commits January 1, 2019 14:29
@iSazonov
Add period 1
e1f93d2
@iSazonov
Add period 2
d3f138f
@iSazonov
Add period 3
d57538a
@iSazonov
Add period 4
b5db4de
@iSazonov
Add period 5
2b831fb
@iSazonov
Add period 6
4702111
@iSazonov
Add period 7
9228438
@iSazonov
Add period 8
9df854f
@iSazonov
Add period 9
0e751b5
@iSazonov
Add period 10
a0e6eb1
@iSazonov
Add period 11
a5216b9
@iSazonov
Add period 12
9055454
@iSazonov
Add period 13
cd8bf1e
@iSazonov
Add period 14
73a5481
@iSazonov
Add period 15
2ff1e07
@iSazonov Ilya (iSazonov) added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Jan 1, 2019
@iSazonov
Ilya (iSazonov) requested review from Steve Lee (SteveL-MSFT) and Dongbo Wang (daxian-dbw) January 1, 2019 09:31
@iSazonov
Ilya (iSazonov) requested review from Bruce Payette (BrucePay), Francisco Gamino (Francisco-Gamino), James Truher (JamesWTruher), Paul Higinbotham (PaulHigin), Travis Plunk (TravisEz13), Aditya Patwardhan (adityapatwardhan), Andrew (anmenaga) and Mike Richmond (mirichmo) as code owners January 1, 2019 09:31
RDIL
Reece Dunham (RDIL) approved these changes Jan 4, 2019
View reviewed changes

@RDIL Reece Dunham (RDIL) left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
daxian-dbw
Dongbo Wang (daxian-dbw) approved these changes Jan 5, 2019
View reviewed changes

@daxian-dbw Dongbo Wang (daxian-dbw) left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ran a script to validate the changes in this PR, and all look good :D Thanks Ilya (@iSazonov)!


CheckAddingPeriod.ps1

param(
    [Parameter(Mandatory=$true)]
    [string]
    $PRUrl,

    [switch]
    $PassThru
)

enum DiffState {
    None
    FileInfo
    DiffContent
}

[DiffState]$state = [DiffState]::None
$Log = @{}

$diffFile = Join-Path -Path $PSScriptRoot -ChildPath "diff.txt"
if (Test-Path -Path $diffFile) { Remove-Item -Path $diffFile -Force -ErrorAction Stop }

##
## .diff and .patch can be append in the end to get some raw content
##
$PRUrl += ".diff"
Invoke-WebRequest -Uri $PRUrl -OutFile $diffFile

$Script:ScanResult = $null
switch -Wildcard -File $diffFile
{    
    "diff --git *"
        {
            $state = [DiffState]::FileInfo
            $fileName = ($_ -split " ")[-1].Substring(2)

            if ($Script:ScanResult -ne $null -and 
                $Script:ScanResult["OriginalStrs"].Count -ne $Script:ScanResult["NewStrs"].Count)
            {
                throw "$($Script:ScanResult['FileName']) contains mismatched + and -"
            }
            
            if ($Log.ContainsKey($fileName)) 
            {
                throw "$fileName appeared twice in diff file. Something is wrong"
            }

            $Script:ScanResult = @{ FileName = $fileName; OriginalStrs = @(); NewStrs = @() }
            $Log[$fileName] = $Script:ScanResult
        }

    "@@ * @@ *"
        {
            $state = [DiffState]::DiffContent
        }

    "-*"
        {
            if ($state -eq [DiffState]::DiffContent)
            {
                $old = $_.Substring(1)
                $Script:ScanResult["OriginalStrs"] += $old
            }
        }

    "+*"
        {
            if ($state -eq [DiffState]::DiffContent)
            {
                $new = $_.Substring(1)
                $Script:ScanResult["NewStrs"] += $new
            }
        }
}


Write-Host -Object "$($Log.Count) files involved in this PR`n"

foreach ($result in $Log.Values)
{
    $newStrs = $result["NewStrs"]
    $originalStrs = $result["OriginalStrs"]

    for ($i = 0; $i -lt $originalStrs.Length; $i++)
    {
        $oldString = $originalStrs[$i]
        $newString = $newStrs[$i]

        $afterReplace = $oldString.Trim() + "."
        $afterProcess = $newString.TrimStart()

        if (!$afterProcess.StartsWith("///") -or $afterReplace -cne $afterProcess)
        {
            Write-Error -Message @"
$($result['FileName']) - mismatch
Old: $oldString
New: $newString
"@
        }
    }
}

if ($PassThru) { return $Log }

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@daxian-dbw
Dongbo Wang (daxian-dbw) merged commit 1be3f4c into PowerShell:master Jan 5, 2019
@iSazonov
Ilya (iSazonov) deleted the style-summary-comments-point branch January 6, 2019 05:53
@iSazonov

Ilya (iSazonov) commented Jan 6, 2019

Copy link
Copy Markdown
Collaborator Author

Dongbo Wang (@daxian-dbw) You could publish the script in gist.
Or do you hope never see so large PRs? :-)

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@daxian-dbw

Dongbo Wang (daxian-dbw) commented Jan 7, 2019 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

The very first version of this script was published in gist years ago, at https://gist.github.com/daxian-dbw/3df8f9236a73a1d9b8c5cc913476d618
The scripts I used to validate this PR and the other one were slightly updated on top of the original one.

Or do you hope never see so large PRs? :-)

Well, I do wish we don't have huge PRs like this one, but it's inevitable for style changes 😄

vexx32 and iSazonov reacted with laugh emoji
All reactions
  • 😄 2 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
@iSazonov @daxian-dbw
Style: Add the ending period to the XML document texts (PowerShell#8577)
20a2914
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daxian-dbw Dongbo Wang (daxian-dbw) daxian-dbw approved these changes
@SteveL-MSFT Steve Lee (SteveL-MSFT) Awaiting requested review from SteveL-MSFT
@adityapatwardhan Aditya Patwardhan (adityapatwardhan) Awaiting requested review from adityapatwardhan adityapatwardhan is a code owner
@anmenaga Andrew (anmenaga) Awaiting requested review from anmenaga
@BrucePay Bruce Payette (BrucePay) Awaiting requested review from BrucePay
@Francisco-Gamino Francisco Gamino (Francisco-Gamino) Awaiting requested review from Francisco-Gamino
@JamesWTruher James Truher (JamesWTruher) Awaiting requested review from JamesWTruher
@mirichmo Mike Richmond (mirichmo) Awaiting requested review from mirichmo
@PaulHigin Paul Higinbotham (PaulHigin) Awaiting requested review from PaulHigin
@TravisEz13 Travis Plunk (TravisEz13) Awaiting requested review from TravisEz13 TravisEz13 is a code owner
+1 more reviewer
@RDIL Reece Dunham (RDIL) RDIL approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@iSazonov @daxian-dbw @RDIL
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.