Skip to content
The meeting of Clojure doc strings' chocolate with Midje facts' peanut butter.
Clojure
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
resources/pbc-assets
src/peanut_butter_cup
test/peanut_butter_cup/test
.gitignore
LICENSE.txt
README.md
TODO.org
project.clj

README.md

Peanut Butter Cup

Clojure doc strings are the chocolate. Midje facts are peanut butter. Each good on their own, but even betten better when combined.

Peanut Butter Cup will produce HTML documentation for projects combining the doc string and argument lists from a function's definition with example usages from its Midje facts.

Status

At this point peanut-butter-cup.core/get-fn-metadata-and-facts can take a namespace and return a seq of metadata extracted from the public vars in that namespace, updated with the corresponding facts from Midje. Generating HTML output is still to be done.

Acknowledgements

A big thank you goes to Alex Baranosky (@Baranosky) for adding a hook to Midje enabling Peanut Butter Cup--or any other tool--to tap into the parsed representation of facts.

License

Copyright (c) 2012 Greg Spurrier. Distributed under the MIT license. See LICENSE.txt for details.

Something went wrong with that request. Please try again.