Skip to content

Commit

Permalink
chore(build): auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
astronvimbot committed Jan 26, 2024
1 parent 8287fea commit 5749aa3
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 27 deletions.
25 changes: 12 additions & 13 deletions doc/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -703,13 +703,6 @@ function astrocore.rooter.detect(bufnr?: integer, all?: boolean)

*return* `detected` — roots

### disabled


```lua
boolean
```

### exists


Expand All @@ -728,16 +721,11 @@ function astrocore.rooter.exists(path: string)


```lua
function astrocore.rooter.info(silent?: integer)
-> the: string
function astrocore.rooter.info()
```

Get information information about the current root

*param* `silent` — whether or not to notify with verbose details

*return* `the` — currently detected root

### is_excluded


Expand Down Expand Up @@ -825,6 +813,17 @@ This module can be loaded with `local ui = require("astrocore.toggles")`
copyright 2023
license GNU General Public License v3.0

### autochdir


```lua
function astrocore.toggles.autochdir(silent?: boolean)
```

Toggle rooter autochdir

*param* `silent` — if true then don't sent a notification

### autopairs


Expand Down
27 changes: 13 additions & 14 deletions doc/astrocore.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*astrocore.txt* For Neovim >= 0.9.0 Last change: 2024 January 25
*astrocore.txt* For Neovim >= 0.9.0 Last change: 2024 January 26

==============================================================================
Table of Contents *astrocore-table-of-contents*
Expand Down Expand Up @@ -924,13 +924,6 @@ _param_ `all` — whether to return all roots or just one
_return_ `detected` — roots


DISABLED ~

>lua
boolean
<


EXISTS ~

>lua
Expand All @@ -948,16 +941,11 @@ _return_ `exists` — whether or not the path exists
INFO ~

>lua
function astrocore.rooter.info(silent?: integer)
-> the: string
function astrocore.rooter.info()
<

Get information information about the current root

_param_ `silent` — whether or not to notify with verbose details

_return_ `the` — currently detected root


IS_EXCLUDED ~

Expand Down Expand Up @@ -1046,6 +1034,17 @@ This module can be loaded with `local ui = require("astrocore.toggles")`
copyright 2023 license GNU General Public License v3.0


AUTOCHDIR ~

>lua
function astrocore.toggles.autochdir(silent?: boolean)
<

Toggle rooter autochdir

_param_ `silent` — if true then don’t sent a notification


AUTOPAIRS ~

>lua
Expand Down

0 comments on commit 5749aa3

Please sign in to comment.