search

dataplat / docs

The documentation for dbatools module. Issues with command doc and bugs should be reported to dataplat/dbatools.
https://docs.dbatools.io
15 stars 12 forks source link

Add-DbaAgDatabase example 5 spills out of code block #84

Closed luke-mckee-ol closed 6 months ago

luke-mckee-ol commented 1 year ago

image

See Example 5 on Add-DbaAgDatabase

I'm happy to contrib to fix it, but I'm not sure how it's meant to be handled or what engine you're using to generate docs and can't find an example of another command that utilizes a ;. Don't use this lib super often so not so familiar. If you can link me one I'll action it when I get a minute.

niphlod commented 1 year ago

hi @luke-mckee-ol , thanks for the report. Frankly, it's not the ; ... how do I know this ? Try zooming back, everything stays the same... we could fix what translates the inline help to the base data that "generates the page" but frankly the problem here is in the "source data", which is the function ... the example 5 is just too damn long to be readable, and I guess it could benefit from a refactor splitting it on multiple lines directly making a pr against https://github.com/dataplat/dbatools/blob/master/public/Add-DbaAgDatabase.ps1. That'll serve everybody: fix the site AND the inline help on the various IDEs. We should strive to have examples lines with 100/120 chars long at top.

luke-mckee-ol commented 1 year ago

Thanks @niphlod , I've updated the title to reflect your feedback.

I will take a shot at making the example multiples lines when I get an extra minute if no one beats me to it :)

niphlod commented 6 months ago

forgot about this but it seems still an issue, I'll see if I can fix it in the next few days