{"id":1669,"date":"2013-03-19T10:52:09","date_gmt":"2013-03-19T15:52:09","guid":{"rendered":"http:\/\/www.kickflop.net\/blog\/?p=1669"},"modified":"2013-03-19T10:52:09","modified_gmt":"2013-03-19T15:52:09","slug":"documenting-bash-scripts","status":"publish","type":"post","link":"https:\/\/www.kickflop.net\/blog\/2013\/03\/19\/documenting-bash-scripts\/","title":{"rendered":"Documenting bash scripts"},"content":{"rendered":"<p>For those of us still in the <code>bash<\/code> trenches now and then, I learned you can avoid the hassle of hash\/octothorpe (#) commenting blocks of documentation in your scripts by using a standard &#8220;here&#8221; doc prefixed by the no-op expression (:).<\/p>\n<p>Clearly this is something you&#8217;d only want to do for major blocks of text, like a large documentation block at the start of a script.<\/p>\n<p>Example:<\/p>\n<pre>\r\n: <<'DOCUMENTATION'\r\n\r\nMy free-form documentation here.\r\n\r\nDOCUMENTATION\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"<p>For those of us still in the bash trenches now and then, I learned you can avoid the hassle of&hellip;<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[24,11,48],"tags":[],"class_list":["post-1669","post","type-post","status-publish","format-standard","hentry","category-programming","category-sysadmin","category-unixlinux"],"_links":{"self":[{"href":"https:\/\/www.kickflop.net\/blog\/wp-json\/wp\/v2\/posts\/1669","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.kickflop.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.kickflop.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.kickflop.net\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.kickflop.net\/blog\/wp-json\/wp\/v2\/comments?post=1669"}],"version-history":[{"count":3,"href":"https:\/\/www.kickflop.net\/blog\/wp-json\/wp\/v2\/posts\/1669\/revisions"}],"predecessor-version":[{"id":1672,"href":"https:\/\/www.kickflop.net\/blog\/wp-json\/wp\/v2\/posts\/1669\/revisions\/1672"}],"wp:attachment":[{"href":"https:\/\/www.kickflop.net\/blog\/wp-json\/wp\/v2\/media?parent=1669"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.kickflop.net\/blog\/wp-json\/wp\/v2\/categories?post=1669"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.kickflop.net\/blog\/wp-json\/wp\/v2\/tags?post=1669"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}