Feature: Add support for additional PlatyPS MarkdownHelp parameters (#77) #78
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joshooaj
force-pushed
the
joshooaj/feat-77
branch
from
d549052 to
8020dac
Compare
HeyItsGilbert
force-pushed
the
joshooaj/feat-77
branch
from
8020dac to
35424f1
Compare
…ke#77) * Add `AlphabeticParamsOrder`, `ExcludeDontShow`, and `UseFullTypeName` options to `$PSBPreference.Docs` with default value of `$false` in `build.properties.ps1` * Add the same three parameters to `Build-PSBuildMarkdown` * Pass the same three parameters to `Build-PSBuildMarkdown` from `IB.tasks.ps1` and `psakeFile.ps1` * Add the same three parameters to the list of configurable options in the readme file
joshooaj
force-pushed
the
joshooaj/feat-77
branch
from
35424f1 to
04e2b1c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
AlphabeticParamsOrder,ExcludeDontShow, andUseFullTypeNameoptions to$PSBPreference.Docswith default value of$falseinbuild.properties.ps1Build-PSBuildMarkdownBuild-PSBuildMarkdownfromIB.tasks.ps1andpsakeFile.ps1Related Issue
#77
Motivation and Context
I want to have parameters sorted alphabetically in my markdown documentation, and I do not want to show parameters in the documentation with the
DontShowattribute. I don't need to set theUseFullTypeNameparameter, but it was easy enough to also include this parameter thatNew-MarkdownHelpandUpdate-MarkdownHelphave in common.How Has This Been Tested?
No additional tests have been added yet, but the existing tests still pass.
Checklist: