Skip to content

Commit

Permalink
chore(docs): autogenerate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
willothy authored and github-actions[bot] committed Dec 30, 2024
1 parent 263ffb2 commit a5149d5
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions doc/flatten.nvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ WINDOW ~
- `guest_cwd``string`
- The current working directory of the guest instance.
- `data``any`
- The data passed to the host from the `guest_data` callback.
- The data passed to the host from the `guest_data` hook.
- `Flatten.BufInfo`
- `fname``string`
- `bufnr``integer`
Expand All @@ -227,7 +227,7 @@ Defaults are in `flatten.hooks`.
- Called before opening files.
- `Flatten.PreOpenContext`
- `data``any`
- The data passed to the host from the `guest_data` callback.
- The data passed to the host from the `guest_data` hook.
- `hooks.post_open``fun(opts: Flatten.PostOpenContext)`
- Called after opening files.
- `Flatten.PostOpenContext`
Expand All @@ -242,14 +242,14 @@ Defaults are in `flatten.hooks`.
- `is_diff``boolean`
- Whether the files were opened in diff mode.
- `data``any`
- The data passed to the host from the `guest_data` callback.
- The data passed to the host from the `guest_data` hook.
- `hooks.block_end``fun(opts: Flatten.BlockEndContext)`
- Called when the host closes the file.
- `Flatten.BlockEndContext`
- `filetype``string`
- The filetype of the file that was opened.
- `data``any`
- The data passed to the host from the `guest_data` callback.
- The data passed to the host from the `guest_data` hook.
- `hooks.no_files``fun(opts: Flatten.NoFilesArgs): Flatten.NoFilesBehavior`
- Called when no files are passed to a guest instance, to determine what to do.
- `Flatten.NoFilesArgs`
Expand Down Expand Up @@ -279,8 +279,8 @@ exists).

Note that when opening a file in blocking mode, such as a git commit, the
terminal will be inaccessible. You can get the filetype from the bufnr or
filetype arguments of the `post_open` callback to only close the terminal for
blocking files, and the `block_end` callback to reopen it afterwards.
filetype arguments of the `post_open` hook to only close the terminal for
blocking files, and the `block_end` hook to reopen it afterwards.

Here’s my setup for toggleterm, including an autocmd to automatically close a
git commit buffer on write:
Expand Down

0 comments on commit a5149d5

Please sign in to comment.