nvim-plugins/aerial.nvim
1
0
Fork 0
mirror of https://github.com/stevearc/aerial.nvim synced 2024-09-16 14:34:08 +02:00
Code Issues Projects Releases Packages Wiki Activity

[docgen] Update docs

Browse source 
skip-checks: true
This commit is contained in:
Github Actions 2023-01-06 18:23:06 +00:00
parent b1e6c7d94b
commit 5b04ae9824
3 changed files with 10 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -310,16 +310,10 @@ require("aerial").setup({
icons = {},
-- Control which windows and buffers aerial should ignore.
-- If attach_mode is "global", focusing an ignored window/buffer will
-- not cause the aerial window to update.
-- If open_automatic is true, focusing an ignored window/buffer will not
-- cause an aerial window to open.
-- If open_automatic is a function, ignore rules have no effect on aerial
-- window opening behavior; it's entirely handled by the open_automatic
-- function.
-- Aerial will not open when these are focused, and existing aerial windows will not be updated
ignore = {
-- Ignore unlisted buffers. See :help buflisted
unlisted_buffers = true,
unlisted_buffers = false,
-- List of filetypes to ignore.
filetypes = {},
@ -327,7 +321,7 @@ require("aerial").setup({
-- Ignored buftypes.
-- Can be one of the following:
-- false or nil - No buftypes are ignored.
-- "special" - All buffers other than normal buffers are ignored.
-- "special" - All buffers other than normal and help buffers are ignored.
-- table - A list of buftypes to ignore. See :help buftype for the
-- possible values.
-- function - A function that returns true if the buffer should be

14
doc/aerial.txt
View file

@ -149,16 +149,10 @@ OPTIONS *aerial-option
icons = {},
-- Control which windows and buffers aerial should ignore.
-- If attach_mode is "global", focusing an ignored window/buffer will
-- not cause the aerial window to update.
-- If open_automatic is true, focusing an ignored window/buffer will not
-- cause an aerial window to open.
-- If open_automatic is a function, ignore rules have no effect on aerial
-- window opening behavior; it's entirely handled by the open_automatic
-- function.
-- Aerial will not open when these are focused, and existing aerial windows will not be updated
ignore = {
-- Ignore unlisted buffers. See :help buflisted
unlisted_buffers = true,
unlisted_buffers = false,
-- List of filetypes to ignore.
filetypes = {},
@ -166,7 +160,7 @@ OPTIONS *aerial-option
-- Ignored buftypes.
-- Can be one of the following:
-- false or nil - No buftypes are ignored.
-- "special" - All buffers other than normal buffers are ignored.
-- "special" - All buffers other than normal and help buffers are ignored.
-- table - A list of buftypes to ignore. See :help buftype for the
-- possible values.
-- function - A function that returns true if the buffer should be
@ -518,7 +512,7 @@ sync_folds({bufnr}) *aerial.sync_fold
Sync code folding with the current tree state.
Parameters:
{bufnr} `integer`
{bufnr} `nil|integer`
Note:
Ignores the 'link_tree_to_folds' config option.

6
doc/api.md
View file

@ -271,9 +271,9 @@ Toggle the collapsed state at the selected location
`sync_folds(bufnr)` \
Sync code folding with the current tree state.
| Param | Type | Desc |
| ----- | --------- | ---- |
| bufnr | `integer` | |
| Param | Type | Desc |
| ----- | -------------- | ---- |
| bufnr | `nil\|integer` | |
**Note:**
<pre>