marginalia

marginalia copied to clipboard

How to handle nested comments?

9

With the latest fix for the parser, it now has been improved to handle top-level versus nested comments. For the moment, it leaves them untouched. I wonder if we could...

budu

Can we leverage [Instaparse](https://github.com/Engelberg/instaparse) to enhance our current parser? This one will probably require a lot of effort so I might put a bounty on it.

gdeer81

Handle `lein-exec` scripts

1

For short little programs, I often don't bother with `project.clj` and use the marvelous [`lein-exec`](https://github.com/kumarshantanu/lein-exec) plugin instead. For example, ``` #!/usr/bin/env lein-exec (require 'leiningen.exec) (leiningen.exec/deps '[[clj-time "0.4.3"]]) (use '[clojure.string :only...

eigenhombre

Datomic reader literal makes Marginalia choke

4

Marginalia chokes on the `#db/id` literal form in the following -- if I comment that out, document generation for my entire project works fine. Note also that unit tests covering...

eigenhombre

Tests don't run on master or on v0.8.0

1

$ lein test Exception in thread "main" java.lang.ClassCastException: java.util.regex.Pattern cannot be cast to clojure.lang.IFn at marginalia.core$processable_file_QMARK_.invoke(core.clj:87) at clojure.lang.AFn.applyToHelper(AFn.java:163) at clojure.lang.AFn.applyTo(AFn.java:151) at clojure.core$apply.invoke(core.clj:619) at clojure.core$partial$fn__4190.doInvoke(core.clj:2396) at clojure.lang.RestFn.invoke(RestFn.java:408) at clojure.core$filter$fn__4226.invoke(core.clj:2533) at clojure.lang.LazySeq.sval(LazySeq.java:42)...

MichaelBlume

Every 3rd time I run, I get an exception

2

Every 3rd time or so I run Marginalia on my code, I get the error below. Rerun again, without any changes, and it will work. So it is most likely...

mattiasw2

Allow a header doc

2

Marg currently processes each file in turn generating the docs in order. However, it would be nice to allow the specification of a documentation header that is always placed at...

fogus

Empty Double Quotes are Removed by Marg

2

For example, let say this is in your code: (clojure.string/replace (row 1) #"~" "") After marg docs generation, the "" is missing from the source code on the right hand...

ghost

Bug or missing documentation for LaTex code when MD markup conflicts

1

In some cases, there is a conflict between LaTeX markup and MD's. An example is: ``` \\(C_{1},...,C_{j}\\) ``` If you use that LaTeX code in your comment, then it won't...

fgiasson

Markdown extension for linking to a function in docstrings and comments

1

Something else we could get with ids on code blocks (see #155) is linking between functions in docstrings and comments. Something like: ``` clojure ;; This is a function that...

metasoarous