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 — Fix 'Accept pipeline input' properties in documentation of Invoke-Formatter by bergmeister · Pull Request #1833 · PowerShell/PSScriptAnalyzer

Conversation

@bergmeister

@bergmeister Christoph Bergmeister (bergmeister) commented Aug 27, 2022 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Collaborator

PR Summary

PR #1763 made Invoke-Formatter accept pipeline input but tests didn't catch that cmdlet docs weren't updated. This fixes the docs and adds tests for pipeline input. Since that pull request hasn't been released yet, no need to update Microsoft docs.

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 .cs, .ps1 and .psm1 files have the correct copyright header
  • Make sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentation
  • 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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bergmeister
Correct pipeline acceptance docs for Invoke-Formatter.md
c1ea4e5
@bergmeister Christoph Bergmeister (bergmeister) added the Area - Documentation label Aug 27, 2022
@bergmeister
Christoph Bergmeister (bergmeister) requested review from James Truher (JamesWTruher) and Sean Wheeler (sdwheeler) August 27, 2022 13:49
@bergmeister Christoph Bergmeister (bergmeister) added this to the 1.21 milestone Aug 27, 2022
sdwheeler
Sean Wheeler (sdwheeler) approved these changes Aug 27, 2022
View reviewed changes

@sdwheeler Sean Wheeler (sdwheeler) 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.

LGTM

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
bergmeister reacted with hooray emoji
All reactions
  • 🎉 1 reaction
JamesWTruher
James Truher (JamesWTruher) reviewed Aug 30, 2022
View reviewed changes
Comment thread Tests/Engine/ModuleHelp.Tests.ps1
foreach($parameterAttribute in $parameter.Attributes) {
if ($parameterAttribute.ValueFromPipeline -eq $null) { continue }

$parameterHelpPipelineInput = if ($parameterHelp.pipelineInput -eq 'True (ByPropertyName, ByValue)') {

@JamesWTruher James Truher (JamesWTruher) Aug 30, 2022

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.

is the string format of this going to be consistent

Sorry, something went wrong.

Uh oh!

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

@bergmeister Christoph Bergmeister (bergmeister) Aug 30, 2022

Copy link
Copy Markdown
Collaborator Author

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.

yes and if not the test will fail anyway :-)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
JamesWTruher
James Truher (JamesWTruher) approved these changes Aug 30, 2022
View reviewed changes
@JamesWTruher
James Truher (JamesWTruher) merged commit fcead29 into PowerShell:master Aug 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers
@JamesWTruher James Truher (JamesWTruher) JamesWTruher approved these changes
@sdwheeler Sean Wheeler (sdwheeler) sdwheeler 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

Area - Documentation

Projects

None yet

Milestone

1.21

Development

Successfully merging this pull request may close these issues.

Uh oh!

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

3 participants

@bergmeister @JamesWTruher @sdwheeler
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.