marginalia

marginalia copied to clipboard

With ids on html code elements for vars (see #155), it would be possible to automatically (optionally; opt-in) add function/var links to the table of contents. This would (I think)...

metasoarous

It would be great to have a link like `my.documentation.url/namespace/#my-cool-defn` to point someone to the docs for a particular function. For compilation to an uberdoc, could just be namespaced var...

metasoarous

Option to add project README.md to the output?

4

Using the README as a start for documentation output could be nice for intro content. Is this out of scope?

metasoarous

chokes on my project.clj

6

My project.clj looks a bit like: ``` ;; Pick up special frobbing (require 'mine.frob) (defproject flib (frob/twiggle) "Flib at high speed" ...) ``` And I would love to use marginalia...

cvillecsteele

No doc-string recognized for the functions that use Prismatic's Schema

2

More specifically, if the function includes a return type, as defined in Schema by: ``` clojure (defn name :- Type "doc-string" [args] body) ``` Then Marginalia misses the doc-string, as...

luxbock

Marginalia does not appear to produce correct output for domina 1.0.4

3

I added the plugin to domina's `project.clj` file `lein marg` produces: ``` Compiling ClojureScript. Exception in thread "main" java.lang.RuntimeException: Unable to resolve symbol: cond-> in this context, compiling:(cljs/analyzer.clj:624) at clojure.lang.Compiler.analyze(Compiler.java:6281)...

jdeisenberg

Would be nice if marginalia could look at some attribute in project.clj for default run settings, so these don't have to be specified at the command line every time.

metasoarous

Docs within defrecord

6

Hello! Is there a way to add docs for the method implementations in `defrecord`? Right now I just have a big block of comments before the `defrecord` expression, which is...

atroche

LaTeX apparently not parsed properly (issues with double quoting)

2

When I check Marginalia's code, I can see that the following LaTeX code get properly parsed: ``` \\(a \ne 0\\) ``` Once parsed by Marginalia, it becomes `\(a \ne 0\)`...

fgiasson

lein marg runs all Midje tests

1

Running `lein marg` seems to run all my midje `fact`s. Is this desired? Could this be made configurable? I suspect Marginalia is evaluating all top level forms. Must it?

eigenhombre