leigh/outline.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: More consistency in referring to config options

Browse Source
This commit is contained in:
hedy
2023-11-18 22:31:33 +08:00
parent 21b0541f2f
commit 036bae6834
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -516,7 +516,7 @@ A fallback is always used if the previous candidate returned a falsey value.
With bang, it can be understood as the converse of `peek_location`. With bang, it can be understood as the converse of `peek_location`.
This is automatically triggered on events This is automatically triggered on events
`config.outline_items.auto_update_events.follow`. `outline_items.auto_update_events.follow`.
You can also trigger this manually using the `restore_location` keymap You can also trigger this manually using the `restore_location` keymap
(default `<C-g>`) from the outline window. (default `<C-g>`) from the outline window.
@@ -526,7 +526,7 @@ A fallback is always used if the previous candidate returned a falsey value.
Trigger refresh of symbols from provider and update outline items. Trigger refresh of symbols from provider and update outline items.
This is automatically triggered on events This is automatically triggered on events
`config.outline_items.auto_update_events.refresh`. `outline_items.auto_update_events.refresh`.
## Default keymaps ## Default keymaps
@@ -660,7 +660,7 @@ require'outline'
With `opts.focus_outline=false`, cursor focus will remain on code window. With `opts.focus_outline=false`, cursor focus will remain on code window.
This is automatically called on events This is automatically called on events
`config.outline_items.auto_update_events.follow`. `outline_items.auto_update_events.follow` from config.
- **is_focus_in_outline()** - **is_focus_in_outline()**
@@ -671,7 +671,7 @@ require'outline'
Re-request symbols from provider and update outline items. Re-request symbols from provider and update outline items.
This is automatically called on events This is automatically called on events
`config.outline_items.auto_update_events.refresh`. `outline_items.auto_update_events.refresh` from config.
## Tips ## Tips