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

better help rendering #8

Closed niphlod closed 6 years ago

niphlod commented 6 years ago

Managed to do this

image

but the problem/constraint is that multiline statements in the "commandline" of the help are not supported by CBH. So either we go for this representation and go correct the CBH on the few commands that have multiline examples, or we keep it the way they are right now...

e.g. of "mangled multiline"

image

potatoqualitee commented 6 years ago

@wsmelton took care of a lot of this last night 🎉 ! Do you have a suggestion for https://docs.dbatools.io/#Export-DbaScript example 7?

niphlod commented 6 years ago

is the key. See my previous PR on that huge multiline splat on logshipping function

Il gio 4 ott 2018, 10:43 Chrissy LeMaire notifications@github.com ha scritto:

@wsmelton https://github.com/wsmelton took care of a lot of this last night 🎉 ! Do you have a suggestion for https://docs.dbatools.io/#Export-DbaScript example 7?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/sqlcollaborative/docs/issues/8#issuecomment-426935311, or mute the thread https://github.com/notifications/unsubscribe-auth/AAHdB9os64YcrMp3EXJd1F10ityORucmks5uhcpMgaJpZM4Wy3bc .

niphlod commented 6 years ago

okay, gonna fix it directly.

potatoqualitee commented 6 years ago

We waiting to close this until we are finiished adding PS C:> or can we now?

niphlod commented 6 years ago

no, we can now, the general idea on how to write CBH and how the rendering goes has been "formalized"