speced/doc is a drop-in replacement for clojure.repl/doc. It macroexpands to it, and in addition to that, it possibly printlns the "docstring" of a given spec defined with def-with-doc.
I would recommend to refer doc in your user.clj / dev.clj.
QA plan
Verify that the tests make sense
Feel free to play with things in a repl:
Also feel free to open nedap.utils.spec.doc/rebl-doc-registry in REBL:
Author checklist
[x] I have QAed the functionality
[x] The PR has a reasonably reviewable size and a meaningful commit history
[x] I have run the branch formatter and observed no new/significative warnings
[x] I have self-reviewed the PR prior to assignment, and its build passes
Specifically, I have code-reviewed iteratively the PR considering the following aspects in isolation:
[x] Correctness
[x] Robustness (red paths, failure handling etc)
[x] Modular design
[x] Test coverage
[x] Spec coverage
[x] Documentation
[x] Security
[x] Performance
[x] Cross-compatibility (Clojure/ClojureScript)
Reviewer checklist
[ ] I have checked out this branch and reviewed it locally, running it
[x] I have QAed the functionality
I have code-reviewed iteratively the PR considering the following aspects in isolation:
Brief
Fixes https://github.com/nedap/utils.spec/issues/53
speced/doc
is a drop-in replacement forclojure.repl/doc
. It macroexpands to it, and in addition to that, it possibly printlns the "docstring" of a given spec defined with def-with-doc.I would recommend to refer
doc
in your user.clj / dev.clj.QA plan
Verify that the tests make sense
Feel free to play with things in a repl:
nedap.utils.spec.doc/rebl-doc-registry
in REBL:Author checklist
Reviewer checklist