-
Notifications
You must be signed in to change notification settings - Fork 0
Note Structure
D'Note scans for the common noting pattern used by develepors of many laguages of an all-caps label followed bt a colon. To be more specific, for D'Note to recogznie a note, it needs ot follow this simple set of rules:
-
Notes start with an all-caps label punctuated with a colon, followed by the note's text.
-
Any note that requires more than one line must remain flush to the left margin (the margin is set by the first line). This is done because RDoc will mistake the note for a <pre> block if it is indented.
-
An alternative to the limitation of the last rule is to indent the whole note, making it a <pre> block to RDoc. Then the text layout is free-form.
That's all there is to it, if I can convince the developers of RDoc to recognize labels, we may eventually be able to relax the flush rule, which would be very nice.
It is possible to find notes that do not punctuate the label with a colon using the --no-colon option, but this often returns false positives, so it's use is discouraged.