{"id":243,"date":"2010-02-25T11:17:37","date_gmt":"2010-02-25T00:17:37","guid":{"rendered":"http:\/\/threemillion.net\/blog\/?p=243"},"modified":"2010-02-25T11:17:37","modified_gmt":"2010-02-25T00:17:37","slug":"my-powershell-function-help-does-not-display","status":"publish","type":"post","link":"https:\/\/threemillion.net\/blog\/?p=243","title":{"rendered":"My Powershell Function Help does not display"},"content":{"rendered":"<p>Whilst attempting to add help information to one of my functions this morning, using the new V2 features which allows you to add multi line information, in the same format as builtin cmdlets each time I tested the function the help did not output my custom text . Example:<\/p>\n<pre class=\"brush: powershell; title: ; notranslate\" title=\"\">\r\nhelp Set-VMHostMultipathToRoundRobin\r\n\r\nNAME\r\n    Set-VMHostMultipathToRoundRobin\r\n\r\nSYNOPSIS\r\n\r\n\r\nSYNTAX\r\n    Set-VMHostMultipathToRoundRobin [&lt;CommonParameters&gt;]\r\n\r\n\r\nDESCRIPTION\r\n\r\n\r\nRELATED LINKS\r\n\r\nREMARKS\r\n    To see the examples, type: &quot;get-help Set-VMHostMultipathToRoundRobin -examples&quot;.\r\n    For more information, type: &quot;get-help Set-VMHostMultipathToRoundRobin -detailed&quot;.\r\n    For technical information, type: &quot;get-help Set-VMHostMultipathToRoundRobin -full&quot;.\r\n<\/pre>\n<p>This just wasn&#8217;t working for me and couldn&#8217;t work out why, I am using V2. So what was going on? As the title of post implies, I had tabs instead of space leading up to the text. As soon as I replaced the tabs with space it all worked. Just a small gotcha. Below is my example help text:<\/p>\n<pre class=\"brush: powershell; title: ; notranslate\" title=\"\">\r\n&lt;#\r\n   .SYNOPSIS \r\n      Sets all LUNs attached to the VMHost to user Round Robin Multipathing\r\n   .DESCRIPTION \r\n      More text to describe in more detail the function if required\r\n   .PARAMETER VMHost\r\n      The VMHost (ESX Server) on which to change the LUN Multipathing\r\n   .NOTES \r\n      Author:  Herschelle42\r\n   .EXAMPLE \r\n      Set-VMHostMultipathToRoundRobin (Get-VMHost -name MyESX1)\r\n#&gt; \r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"<p>Whilst attempting to add help information to one of my functions this morning, using the new V2 features which allows you to add multi line information, in the same format <a href=\"https:\/\/threemillion.net\/blog\/?p=243\" class=\"more-link\">[&hellip;]<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"Layout":""},"categories":[8],"tags":[],"_links":{"self":[{"href":"https:\/\/threemillion.net\/blog\/index.php?rest_route=\/wp\/v2\/posts\/243"}],"collection":[{"href":"https:\/\/threemillion.net\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/threemillion.net\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/threemillion.net\/blog\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/threemillion.net\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=243"}],"version-history":[{"count":7,"href":"https:\/\/threemillion.net\/blog\/index.php?rest_route=\/wp\/v2\/posts\/243\/revisions"}],"predecessor-version":[{"id":250,"href":"https:\/\/threemillion.net\/blog\/index.php?rest_route=\/wp\/v2\/posts\/243\/revisions\/250"}],"wp:attachment":[{"href":"https:\/\/threemillion.net\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=243"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/threemillion.net\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=243"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/threemillion.net\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=243"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}