Skip to content
This repository has been archived by the owner on Feb 24, 2021. It is now read-only.

New-DscResourcePowerShellHelp: Restore OutputPath parameter #334

Merged
merged 3 commits into from
Jul 12, 2019

Conversation

X-Guardian
Copy link
Contributor

@X-Guardian X-Guardian commented Jul 10, 2019

Pull Request (PR) description

This PR restores the OutputPath parameter to the New-DscResourcePowerShellHelp function that was removed as part of PR #325.
If the OutputPath parameter is specified, all the PowerShell help files are output to this path. If the OutputPath parameter is not specified, the PowerShell help files are output to each individual resource's en-US folder.

This Pull Request (PR) fixes the following issues

Task list

  • Added an entry under the Unreleased section of the change log in the CHANGELOG.md.
    Entry should say what was changed, and how that affects users (if applicable).
  • Documentation added/updated in README.md.
  • Comment-based help added/updated for all new/changed functions.
  • Localization strings added/updated in all localization files as appropriate.
  • Unit tests added/updated.
  • New/changed code adheres to DSC Resource Style Guidelines and Best Practices.

This change is Reviewable

@codecov-io
Copy link

codecov-io commented Jul 10, 2019

Codecov Report

Merging #334 into dev will increase coverage by <1%.
The diff coverage is 100%.

Impacted file tree graph

@@         Coverage Diff          @@
##            dev   #334    +/-   ##
====================================
+ Coverage    79%    79%   +<1%     
====================================
  Files        12     12            
  Lines      1703   1706     +3     
  Branches      2      2            
====================================
+ Hits       1348   1351     +3     
  Misses      353    353            
  Partials      2      2

@X-Guardian X-Guardian marked this pull request as ready for review July 10, 2019 23:12
Copy link
Contributor

@johlju johlju left a comment

Choose a reason for hiding this comment

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

:lgtm:

@PlagueHO can you merge this? Ignoring some style issue since the whole file has the same issues. Currently the code is consequently wrong at least. ;)

Reviewed 1 of 1 files at r1, 1 of 1 files at r2, 1 of 1 files at r3.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @X-Guardian)


DscResource.DocumentationHelper/PowerShellHelp.psm1, line 37 at r3 (raw file):

The help files are output to the OutputPath directory if specified, or if not, they are
output to the releveant resource's 'en-US' directory.

Can we add something like this to the README.md too? https://github.com/PowerShell/DscResource.Tests#powershellhelp

@johlju
Copy link
Contributor

johlju commented Jul 11, 2019

@gaelcolas If you have time, please merge this.

@PlagueHO
Copy link
Contributor

Yep- I flagged the style issues too. There is also some design improvements that should be made but are identified in a separate issue. I'm trying to merge this one but having trouble on the bus.

@PlagueHO
Copy link
Contributor

I cant merge on my phone because it requires the reviewable discussion to be closed. If you can close this discussion @johlju I can merge this.

@johlju
Copy link
Contributor

johlju commented Jul 11, 2019

@PlagueHO There we go. Thought I added it as satisfied by apparently i didn't. Retracted the comment.

@PlagueHO PlagueHO merged commit 85e6783 into PowerShell:dev Jul 12, 2019
@X-Guardian X-Guardian deleted the PowerShellHelp-OutputPath-Fix branch July 31, 2019 06:03
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Invoke-AppveyorAfterTestTask: Exception Calling New-DscResourcePowerShellHelp when Type is 'Wiki'
4 participants