Skip to content

RuleDocumentation: The table of contents contains some errors #887

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
LaurentDardenne opened this issue Feb 14, 2018 · 1 comment · Fixed by #918 or #988
Closed

RuleDocumentation: The table of contents contains some errors #887

LaurentDardenne opened this issue Feb 14, 2018 · 1 comment · Fixed by #918 or #988

Comments

@LaurentDardenne
Copy link

As the location of the rules will be changed soon, I do not know if necessary to indicate, but in doubt ...

For this table :

The following pages are not found (Filenames do not seem to match the title of the table) :

  • AvoidAlias
  • AvoidDefaultTrueValueSwitchParameter
  • AvoidEmptyCatchBlock
  • AvoidReservedCharInCmdlet
  • AvoidReservedParams
  • ProvideDefaultParameterValue
  • ProvideVerboseMessage
  • ReturnCorrectTypeDSCFunctions
  • UseIdenticalMandatoryParametersDSC
  • UseIdenticalParametersDSC
  • UseShouldProcessCorrectly
  • UseStandardDSCFunctionsInResource

This new rules are not in the table (TOC) :

  • AvoidAssignmentToAutomaticVariable
  • AlignAssignmentStatement
  • PossibleIncorrectUsageOfAssignmentOperator

AvoidUninitializedVariable is deprecated rule, but present in the table (TOC).

@bergmeister bergmeister changed the title RuLeDocumentation: The table of contents contains some errors RuleDocumentation: The table of contents contains some errors Feb 14, 2018
@bergmeister
Copy link
Collaborator

@LaurentDardenne @JamesWTruher I would rather remove the table completely because it is unnecessary duplication/maintenance. One can click on any of the rules separately to get the full details or use Get-ScriptAnalyzerRule to get the warning level of the rules in a nice list.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment