Skip to content
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

Enhance Help Documentation Validation for Cmdlets #548

Merged
merged 8 commits into from
Oct 22, 2023

Conversation

SebastianSchuetze
Copy link
Collaborator

PR Summary

This pull request introduces improvements to the validation of cmdlet help documentation. The main changes include:

  1. Ensuring that each cmdlet has at least one example in its associated markdown help file.
  2. Verifying that all defined parameters of a cmdlet are documented under the "## Parameters" section of the markdown file.
  3. Providing an option to ignore specific parameters from the validation, accommodating parameters that are automatically documented during generation.
  4. Adjustments to the regex patterns for more accurate extraction and validation of content.

These enhancements aim to maintain a consistent and high-quality documentation standard for all cmdlets, ensuring that users have access to comprehensive and clear help content.

PR Checklist

@SebastianSchuetze SebastianSchuetze merged commit 33e8b14 into trunk Oct 22, 2023
8 checks passed
@SebastianSchuetze SebastianSchuetze deleted the feature/fix-wrong-documentation branch October 22, 2023 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant