Skip to content

Commit 50d7238

Browse files
author
github-actions
committed
[docgen] Update docs
1 parent 377c295 commit 50d7238

File tree

2 files changed

+25
-5
lines changed

2 files changed

+25
-5
lines changed

doc/orgmode.txt

+23
Original file line numberDiff line numberDiff line change
@@ -2850,6 +2850,29 @@ this to config:
28502850
<
28512851

28522852

2853+
Input *orgmode-Input*
2854+
2855+
- Type: `boolean`
2856+
- Default: `false`
2857+
2858+
By default, Vim's built-in `input()` function is used for input prompts. To use
2859+
Neovim's `vim.ui.input()` function, add this to config:
2860+
2861+
>lua
2862+
require('orgmode').setup({
2863+
ui = {
2864+
input = {
2865+
use_vim_ui = true
2866+
}
2867+
}
2868+
})
2869+
<
2870+
2871+
📝 NOTE: If you are using a plugin for `vim.ui.input`, make sure it supports
2872+
autocompletion for better experience. snacks.nvim
2873+
<https://github.com/folke/snacks.nvim> input module supports autocompletion.
2874+
2875+
28532876
==============================================================================
28542877
2. Troubleshooting *orgmode-troubleshooting*
28552878

doc/orgmode_api.txt

+2-5
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,7 @@ OrgApi.refile({opts}) *OrgApi.refile*
2929
If executed from capture buffer, it will close the capture buffer
3030

3131
Parameters: ~
32-
{opts} (OrgApiRefileOpts)
33-
34-
Returns: ~
35-
(boolean)
32+
{opts} (OrgApiRefileOpts) @return OrgPromise<boolean>
3633

3734

3835
OrgApi.insert_link() *OrgApi.insert_link*
@@ -44,7 +41,7 @@ OrgApi.insert_link() *OrgApi.insert_link*
4441
If <in_file_location> is *<headline>, <headline> is used as prefilled description for the link.
4542
If <protocol> is id, this format can also be used to pass a prefilled description.
4643
@param link_location string
47-
@return boolean
44+
@return OrgPromise<boolean>
4845

4946

5047
OrgApiFile *OrgApiFile*

0 commit comments

Comments
 (0)