dx-spec

dx-spec copied to clipboard

In drafting up the spec and testing out some code examples in CommonMark, I'm really liking the approach of mdconf's tags: instead of

// @param a {string}
// @param b {string}
function b(a, b) {}

It'd be

// - param: a {string}
// - param: b {string}
function b(a, b) {}

Advantages being:

• @param will no longer send a github notification to poor @param every time someone posts it in an issue
• Multiple tags inline look correct through a CommonMark parser, whereas the JSDoc syntax has them smooshed onto one line

Cool! I don't have any big changes planned in the next few days, will be more in the mode of using it occasionally and letting ideas percolate, so no danger of merge conflicts.

Sorry I’ve been spending my time on parsing word documents recently (😰) , so please don’t let this issue block Data.elm!