Janet's docstrings "support some subset of Markdown"...but exactly what?
- #511 Add formatter for Markdown-formatted docstrings - has description of constructs originally supported in pyrmont's PR. There are some differences compared to what is currently supported (e.g. ATM no support for
+
as a list item marker). - #694 A trailing backslash as linebreak in function docstring. - in c911f7c4, the commit that addressed the issue,
doc-format
was substantially changed by bakpakin - #809 (defn fun* [] ()) when displayed with doc shows as (fun) instead of (fun*)
- #998 stop doc-format detecting other modes within code blocks
some amount of support for
- indented code blocks
- fenced code blocks
- paragraphs
- list items
- lists
- unordered lists
- ordered lists
- code spans (e.g. `nil`)
- emphasis and strong emphasis - underline [1], italics, bold
may not support
- thematic breaks
- atx headings
- setext headings
- link reference definitions
- block quotes
- loose lists?
- links
- images
[1] Technically, it seems there is no support for underline in Markdown / CommonMark