Add namespace docstring for new specs

This commit is contained in:
Sean Corfield 2019-05-21 21:55:10 -07:00
parent adf5a03e05
commit 656a0d8d9a

View file

@ -1,6 +1,17 @@
;; copyright (c) 2019 Sean Corfield, all rights reserved ;; copyright (c) 2019 Sean Corfield, all rights reserved
(ns next.jdbc.specs (ns next.jdbc.specs
"Specs for the core API of next.jdbc.
The functions from `next.jdbc` and `next.jdbc.sql` have specs here.
Just `:args` are spec'd. These specs are intended to aid development
with `next.jdbc` by catching simple errors in calling the library.
The `connectable` argument is currently just `any?` but both
`get-datasource` and `get-connection` have stricter specs. If you
extend `Sourceable` or `Connectable`, those specs will likely be too strict.
In addition, there is an `instrument` function that provides a simple
way to instrument all of the `next.jdbc` functions."
(:require [clojure.spec.alpha :as s] (:require [clojure.spec.alpha :as s]
[clojure.spec.test.alpha :as st] [clojure.spec.test.alpha :as st]
[next.jdbc :as jdbc] [next.jdbc :as jdbc]