on master help sign in
Provide an example of idris example
76e0282Markus Klink
docs/reference/documenting.rst+8−1
@@ -61,7 +61,14 @@ italics correctly). A comprehensive set of examples is given below.
61 ||| Add some numbers.
61 ||| Add some numbers.
62 |||
62 |||
63 ||| Addition is really great. This paragraph is not part of the overview.
63 ||| Addition is really great. This paragraph is not part of the overview.
64− ||| Still the same paragraph. Lists are also nifty:
64+ ||| Still the same paragraph.
65+ |||
66+ ||| You can even provide examples which are inlined in the documentation:
67+ ||| ```idris example
68+ ||| add 4 5
69+ ||| ```
70+ |||
71+ ||| Lists are also nifty:
65 ||| * Really nifty!
72 ||| * Really nifty!
66 ||| * Yep!
73 ||| * Yep!
67 ||| * The name `add` is a **bold** choice
74 ||| * The name `add` is a **bold** choice