From 5164c243421e7dd4aa3caf1cdb71cafa8896d16c Mon Sep 17 00:00:00 2001 From: Sean Corfield Date: Sat, 24 Jun 2023 10:23:07 -0700 Subject: [PATCH] improve helpers ns docstring --- CHANGELOG.md | 1 + src/honey/sql/helpers.cljc | 10 +++++++--- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8829892..6bef8ce 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ * 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 [#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. * 2.4.1033 -- 2023-05-22 diff --git a/src/honey/sql/helpers.cljc b/src/honey/sql/helpers.cljc index 0ba5124..ade62b0 100644 --- a/src/honey/sql/helpers.cljc +++ b/src/honey/sql/helpers.cljc @@ -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 "Helper functions for the built-in clauses in honey.sql. - All helper functions are inherently variadic. Typical - usage is threaded, like this: + All helper functions are inherently variadic. + + 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)