zcaudate-me / lein-midje-doc

moved -> 'lucid.publish'
http://docs.caudate.me/lucidity/lucid-publish.html
73 stars 8 forks source link

Arch Documentation Failing inside "against-background" block #13

Open twashing opened 10 years ago

twashing commented 10 years ago

I put the details of the issue into this Clojure google group post. But the main issue is the case where my documentation inside of a _against-background_ block, is being ignored. I looked for lein-midje-doc examples that demonstrate this. But, say purnam or clortex, aren't using against-background blocks, that I can see. Is this expected behaviour, or a bug?

zcaudate commented 10 years ago

Hi Tim.

Thanks for pointing this out. I'm aware of this fact but I'm not sure if I have time to implement the feature.

The point of midje doc is to allow writing of testable documentation, not to turn your midje tests into readable docs. As such, I decided to not implement every feature of midje but instead to just concentrate on the most basic.

There should always be a way to write it without against-background. I'm not a big fan if the macro as I find it sometimes breaks but that's another story altogether.

Hope that helps.

On 18 Aug 2014, at 13:09, Timothy Washington notifications@github.com wrote:

I put the details of the issue into this Clojure google group post. But the main issue is the case where my documentation inside of a against-background block, is being ignored. I looked for lein-midje-doc examples that demonstrate this. But, say purnam or clortex, aren't using against-background blocks, that I can see. Is this expected behaviour, or a bug?

— Reply to this email directly or view it on GitHub.