amalloy / clj-doc-test Goto Github PK
View Code? Open in Web Editor NEWThis project forked from kobold/clj-doc-test
Python-like doctest functionality for Clojure.
License: Eclipse Public License 1.0
This project forked from kobold/clj-doc-test
Python-like doctest functionality for Clojure.
License: Eclipse Public License 1.0
doc-test is a Clojure namespace that provides Python-like doctests [1]. WHY DOC-TEST? ------------- Examples are very useful in documentation and help to clarify the meaning of descriptions. Take #'clojure.set/join: "When passed 2 rels, returns the rel corresponding to the natural join. When passed an additional keymap, joins on the corresponding keys." Que? A simple example is much more clear for someone reading the docs for the first time: (def languages #{{:name "C" :type "procedural"} {:name "Clojure" :type "functional"} {:name "Haskell" :type "functional"}}) (def fun-level #{{:type "procedural" :funness "meh"} {:type "functional" :funness "awesome"}}) => (clojure.set/join languages fun-level) #{{:name "Haskell", :type "functional", :funness "awesome"} {:name "Clojure", :type "functional", :funness "awesome"} {:name "C", :type "procedural", :funness "meh"}} Awesome. The only problem is that sometimes documentation and actual code fall out of sync with each other. Doc-tests provide a way to assure that doesn't happen. The examples in the documentation are tested with the rest of the code! HOW TO DOC-TEST --------------- Here's an example function with some doc-tests: (defn adder "A simple function to test the doctest macro with. => ((adder 1) 2) 4 ; incorrect! => ((adder 4) 5) 9" [n1] (fn [n2] (+ n1 n2))) To generate the tests from #'adder's doc-string: (doc-test adder) Put this wherever you've put the rest of your #'clojure.test/deftests. When the above test is run this error occurs: FAIL in (adder__doc-test__88) (doc_test_tests.clj:19) expected: (clojure.core/= ((adder 1) 2) (quote 4)) actual: (not (clojure.core/= 3 4)) Doc-test makes efforts to make test failures easier to debug. Because your documentation is turned into standard clojure.test declarations, we see the failure display in the same way. The test name is the symbol's name along with "__doc-test__". The expected and actual statements are also exactly what was in the doc-string. [1] http://docs.python.org/library/doctest.html [2] http://clojure.org/API#toc662
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.