Skip to content

Rule documentation titles don't match rule names #729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
juneb opened this issue Mar 3, 2017 · 2 comments
Closed

Rule documentation titles don't match rule names #729

juneb opened this issue Mar 3, 2017 · 2 comments

Comments

@juneb
Copy link
Contributor

juneb commented Mar 3, 2017

The .MD file names in https://github.com/PowerShell/PSScriptAnalyzer/tree/development/RuleDocumentation do not match the rule names, even when you delete the PS prefix.

This error affects the following rules:

AvoidUsingCmdletAliases
AvoidDefaultValueSwitchParameter
AvoidDefaultValueForMandatoryParameter
AvoidUsingEmptyCatchBlock
ReservedCmdletChar
ReservedParams
AvoidUsingUserNameAndPassWordParams
MisleadingBacktick
ShouldProcess
UseUTF8EncodingForHelpFile
DSCDscExamplesPresent
DSCDscTestsPresent
DSCReturnCorrectTypesForDSCFunctions
DSCUseIdenticalMandatoryParametersForDSC
DSCUseIdenticalParametersForDSC
DSCStandardDSCFunctionsInResource
DSCUseVerboseMessageInDSCResource

I'm trying to write a function that opens these files based on the rule name, but it won't work unless the rule names are correct.

So, we either need to change the doc names to match the rules or change the rule names to match the docs.

@kapilmb
Copy link

kapilmb commented Mar 3, 2017

Changing rule names will be a breaking change and so I think the other approach, i.e., to change the doc file names to correspond to that of rule names, is more appropriate here. Thanks for pointing out the discrepancy.

@kapilmb
Copy link

kapilmb commented Apr 3, 2017

Fixed in #742

@kapilmb kapilmb closed this as completed Apr 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants