From 436ea2b462aa5e01067a97020ca3d7fe04d30241 Mon Sep 17 00:00:00 2001
From: Oliver Marriott <hello@omarriott.com>
Date: Tue, 19 Mar 2024 15:31:52 +1100
Subject: [PATCH] chore: bump api docs

---
 API.md             | 16 +++++++++-------
 doc/hotpot-api.txt | 16 +++++++++-------
 2 files changed, 18 insertions(+), 14 deletions(-)

diff --git a/API.md b/API.md
index 48ee88d6..ce0898b3 100644
--- a/API.md
+++ b/API.md
@@ -284,6 +284,9 @@ Optionally accepts an options table which may contain the same keys as
 described for `api.make.build`. By default, `force = true` and
 `verbose = true`.
 
+Note: this function is under `(. (require :hotpot.api.make) :auto :build)`
+NOT `(. (require :hotpot.api.make.auto) :build)`.
+
 
 
 ### `hotpot.api.make.build`
@@ -518,18 +521,17 @@ Returns the path to Hotpots lua cache
 
 ### `hotpot.api.cache.clear-cache`
 
-`(clear-cache)`
+`(clear-cache ?opts)`
 
-Clear all lua cache files
+Clear all lua cache files.
 
+Accepts an optional table of options which may specify {silent=true} to disable prompt.
 
 
-### `hotpot.api.cache.open-cache`
 
-`(open-cache ?how ?opts)`
+### `hotpot.api.cache.open-cache`
 
-Open the cache directory in a split
+`(open-cache ?cb)`
 
-Accepts an optional `how` and `opts` arguments which
-are translated to `(vim.cmd.<how> (cache-path) <opts>)`
+Open the cache directory in a vsplit or calls `cb` function with cache path
 
diff --git a/doc/hotpot-api.txt b/doc/hotpot-api.txt
index 1ddae79b..5bb0b9db 100644
--- a/doc/hotpot-api.txt
+++ b/doc/hotpot-api.txt
@@ -291,6 +291,9 @@ Finds any .hotpot.lua file nearest to given `file-dir-or-dot-hotpot`
         described for `api.make.build`. By default, `force = true` and
         `verbose = true`.
 
+        Note: this function is under `(. (require :hotpot.api.make) :auto :build)`
+        NOT `(. (require :hotpot.api.make.auto) :build)`.
+
 
 ------------------------------------------------------- *hotpot.api.make.build*
 
@@ -534,19 +537,18 @@ Returns the path to Hotpots lua cache
 
 clear-cache~
 
-`(clear-cache)`
+`(clear-cache ?opts)`
+
+Clear all lua cache files.
 
-Clear all lua cache files
+Accepts an optional table of options which may specify {silent=true} to disable prompt.
 
 
 ------------------------------------------------- *hotpot.api.cache.open-cache*
 
 open-cache~
 
-`(open-cache ?how ?opts)`
-
-Open the cache directory in a split
+`(open-cache ?cb)`
 
-Accepts an optional `how` and `opts` arguments which
-are translated to `(vim.cmd.<how> (cache-path) <opts>)`
+Open the cache directory in a vsplit or calls `cb` function with cache path