luciano/honeysql
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve helpers ns docstring

Browse source
This commit is contained in:
Sean Corfield 2023-06-24 10:23:07 -07:00
parent e679e93362
commit 5164c24342
2 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -5,6 +5,7 @@
* Fix [#494](https://github.com/seancorfield/honeysql/issues/494) by supporting expressions in `:on-conflict` instead of just entities. * Fix [#494](https://github.com/seancorfield/honeysql/issues/494) by supporting expressions in `:on-conflict` instead of just entities.
* Address [#493](https://github.com/seancorfield/honeysql/issues/493) by clarifying use of `:values` in CTEs (using `:with`). * Address [#493](https://github.com/seancorfield/honeysql/issues/493) by clarifying use of `:values` in CTEs (using `:with`).
* Address [#489](https://github.com/seancorfield/honeysql/issues/489) by adding more examples around `:update`. * Address [#489](https://github.com/seancorfield/honeysql/issues/489) by adding more examples around `:update`.
* Attempt to improve `honey.sql.helpers` namespace docstring (by adding a note from the relevant **Getting Started** section).
* Update dev/test dependencies. * Update dev/test dependencies.
* 2.4.1033 -- 2023-05-22 * 2.4.1033 -- 2023-05-22

10
src/honey/sql/helpers.cljc
View file

@ -1,10 +1,14 @@
;; copyright (c) 2020-2022 sean corfield, all rights reserved ;; copyright (c) 2020-2023 sean corfield, all rights reserved
(ns honey.sql.helpers (ns honey.sql.helpers
"Helper functions for the built-in clauses in honey.sql. "Helper functions for the built-in clauses in honey.sql.
All helper functions are inherently variadic. Typical All helper functions are inherently variadic.
usage is threaded, like this:
In general, `(helper :foo expr)` will produce `{:helper [:foo expr]}`,
with a few exceptions: see the docstring of the helper function for details.
Typical usage is threaded, like this:
``` ```
(-> (select :a :b :c) (-> (select :a :b :c)