<html><head>
<style id="css_styles">
blockquote.cite { margin-left: 5px; margin-right: 0px; padding-left: 10px; padding-right:0px; border-left: 1px solid #cccccc }
blockquote.cite2 {margin-left: 5px; margin-right: 0px; padding-left: 10px; padding-right:0px; border-left: 1px solid #cccccc; margin-top: 3px; padding-top: 0px; }
a img { border: 0px; }
li[style='text-align: center;'], li[style='text-align: right;'] { list-style-position: inside;}
body { font-family: Segoe UI; font-size: 12pt; }
</style>
</head>
<body>Hi Devs,<div><br /></div><div>When writing Notes, I find myself using markdown-inspired or haddock-inspired features. The reason is that I keep telling myself </div><div><span><br /></span></div><div><span>> In 5 years time, we'll surely have an automated tool that renders Notes referenced under the cursor in a popup in our IDE</span></div><div><span><br /></span></div><div><span>And I might not be completely wrong about that, after all the strong conventions about Note declaration syntax allow me to do jump-to-definition on Note links in my IDE already (thanks to a shell script written by Zubin!).</span></div><div><span>Still, over the years I kept drifting between markdown and haddock syntax, sometimes used `backticked inline code` or haddock 'ticks' to refer to functions in the compiler (sometimes even 'GHC.Fully.Qualified.ticks') and for code blocks I used all of the following forms:</span></div><div><span><br /></span></div><div><span>Haddock "code quote"</span></div><div><span><br /></span></div><div><div><div>> id :: a -> a</div><div>> id x = x</div></div></div><div><br /></div><div>Markdown triple backticks</div><div><br /></div><div>```hs</div><div><div><div><div>id :: a -> a</div><div>id x = x</div></div></div></div><div>```</div><div><br /></div><div>Indentation by spaces</div><div><br /></div><div> id :: a -> a</div><div> id x = x</div><div><br /></div><div>And so on.</div><div><br /></div><div>I know that at least Simon was thrown off in the past about my use of "tool-aware markup", perhaps also because I kept switching the targetted tool. I don't like that either. So I wonder</div><div><ol style="list-style-type: decimal;"><li>Do you think it is worth optimising Notes for post-processing by an external tool?</li><li>I think it's only reasonable if we decide for a target syntax. Which syntax should it be?</li></ol><div>Cheers,</div></div><div>Sebastian</div><div></div></body></html>