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

Get-DbaHelp, gfm compatibility #7364

Merged
merged 2 commits into from
May 26, 2021

Conversation

niphlod
Copy link
Contributor

@niphlod niphlod commented May 24, 2021

Type of Change

  • Bug fix (non-breaking change, fixes # )
  • New feature (non-breaking change, adds functionality, fixes # )
  • Breaking change (effects multiple commands or functionality, fixes # )
  • Ran manual Pester test and has passed (`.\tests\manual.pester.ps1)
  • Adding code coverage to existing functionality
  • Pester test is included
  • If new file reference added for test, has is been added to github.com/sqlcollaborative/appveyor-lab ?
  • Nunit test is included
  • Documentation
  • Build system

Purpose

Compared to what is used on the docs.dbatools.io site, which uses markdown with the "gfm" dialect, some fixes were needed as moving forward PS7's ConvertFrom-Markdown will be used (see dataplat/docs#36) . The point is/was that in gfm-style soft breaks (i.e. a line ending in our inline help) ended up being properly separated by a <br>.
ConvertFrom-Markdown from PS7 doesn't support it, so we need to generate it in here.

@niphlod
Copy link
Contributor Author

niphlod commented May 25, 2021

the read-dbaauditfile test is failing a lot. not only on this PR ^_^

@potatoqualitee
Copy link
Member

Yeah, I removed it from test rotation for now @niphlod. Thank you for the PR!

@potatoqualitee potatoqualitee merged commit 8fb1e56 into dataplat:development May 26, 2021
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

2 participants