Skip to content

Commit

Permalink
chore: bump api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rktjmp committed Mar 19, 2024
1 parent ddcd800 commit 436ea2b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 14 deletions.
16 changes: 9 additions & 7 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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

16 changes: 9 additions & 7 deletions doc/hotpot-api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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*

Expand Down Expand Up @@ -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

0 comments on commit 436ea2b

Please sign in to comment.