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

Multiple changes/adaptions #504

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Commits on Jan 25, 2021

  1. Multiple changes/adaptions:

    * Sections, like for example Description, without data (and without example data due to new switch -SkipEmptyFields) will no longer be rendered
    * Added switch -SinglePage to cmdlet New-MarkdownHelp so all functions will be written into the same module markdown file (same name as module landing page would normally have), instead of writing every cmdlet into its own markdown file
    * Added switch -NoInputOutputFormatting to cmdlets New-MarkdownHelp, Update-MarkdownHelp and Merge-MarkdownHelp so Input/Output comments won't be formatted. This is because microsoft gives us no way to actually set the values in Input/Output correct (type, description) but will put everything written there into the "type" property, so all text will be formatted bold. So for this to work correctly (not as intended) this switch needs to be provided so everything in the Input/Output section will just be written as is, without any bold formatting.
    * Added switch -SkipEmptyFields to cmdlets New-MarkdownHelp, Update-MarkdownHelp and Update-MarkdownHelpModule which will omit example text for empty fields which were not provided/found and will instead just skip empty sections
    * Added switch -CreateTableOfContent to cmdlet New-MarkdownHelp which will create an additional table of content in the single- or module-landing-page.
    * Added switch -WithModuleMetaData to cmdlet New-MarkdownHelp which will add a section "Module Metadata" filled with the following data (as far as that data exists): Module version, Author, Company, Copyright, Tags, License Uri, Project Uri
    * Added module version to yaml metadata at beginning of markdown
    * Adapted UnitTests to work with removed empty sections (due to missing data)
    echalone committed Jan 25, 2021
    Configuration menu
    Copy the full SHA
    27f70be View commit details
    Browse the repository at this point in the history

Commits on Jan 26, 2021

  1. Configuration menu
    Copy the full SHA
    fe87f74 View commit details
    Browse the repository at this point in the history
  2. Updated help files

    echalone committed Jan 26, 2021
    Configuration menu
    Copy the full SHA
    6a61aea View commit details
    Browse the repository at this point in the history
  3. Added some comments to rerun pull request checks (seems there was a r…

    …andom error in the build, so we gotta restart it)
    echalone committed Jan 26, 2021
    Configuration menu
    Copy the full SHA
    d300165 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    49f649e View commit details
    Browse the repository at this point in the history

Commits on Jan 29, 2021

  1. Fixed GUID output for switch WithModuleMetaData

    Added help for new switches
    echalone committed Jan 29, 2021
    Configuration menu
    Copy the full SHA
    e265fce View commit details
    Browse the repository at this point in the history
  2. Fixed some formatting bugs

    echalone committed Jan 29, 2021
    Configuration menu
    Copy the full SHA
    5877b1a View commit details
    Browse the repository at this point in the history