yogsototh/marginalia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Replacing "#" with "@" as the directive-start character.

Browse source 
In the excitement of getting something working and polished, I
overlooked the fact that "#" is indeed part of Markdown syntax, and that
there is little to distinguish `;; #Directive` from `;; # Title`.

"@" is visually distinctive, and is not currently part of Markdown.
This commit is contained in:
Ben Bader 2014-02-16 15:57:54 -08:00
parent 7e1eee7ff7
commit 28eff57a69
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/marginalia/parser.clj
View file

@ -50,14 +50,14 @@
(def directives
"Marginalia can be given directives in comments. A directive is a comment
line containing a directive name, in the form `;; #DirectiveName`.
line containing a directive name, in the form `;; @DirectiveName`.
Directives change the behavior of the parser within the files that contain
them.
The following directives are defined:
* `#MargDisable` suppresses subsequent comments from the docs
* `#MargEnable` includes subsequent comments in the docs"
* `@MargDisable` suppresses subsequent comments from the docs
* `@MargEnable` includes subsequent comments in the docs"
{"MargDisable" (fn [] (swap! *comments-enabled* (constantly false)))
"MargEnable" (fn [] (swap! *comments-enabled* (constantly true)))})
@ -66,7 +66,7 @@
indicating whether the line should be included in the comments
list."
[line]
(let [directive (->> (re-find #"^;+\s*#(\w+)" line)
(let [directive (->> (re-find #"^;+\s*@(\w+)" line)
(last)
(get directives))]
(when directive