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

doc: fix formatting for table[] types

Browse source
This commit is contained in:
Steven Arcangeli 2022-11-14 09:45:22 -08:00
parent 57fbe44f96
commit 6146e0aaea
3 changed files with 3 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/nvim_doc_tools vendored

@ -1 +1 @@
Subproject commit 96e7b98ec289710b0337d8255629ca2814247b9e
Subproject commit bbf27ba0a8a59d68f8e0aa415f0fb2f3b0aa8e8e

4
doc/aerial.txt
View file

@ -422,14 +422,12 @@ prev_up({count}) *aerial.prev_u
Parameters:
{count} `nil|integer` How many levels to jump up (default 1)
get_location({exact}): table *aerial.get_location*
get_location({exact}): table[] *aerial.get_location*
Get a list representing the symbol path to the current location.
Parameters:
{exact} `nil|boolean` If true, only return symbols if we are exactly
inside the hierarchy. When false, will return the closest symbol.
Returns:
`table` []
Note:
Returns empty list if none found or in an invalid buffer.

7
doc/api.md
View file

@ -163,18 +163,13 @@ Jump to a symbol higher in the tree, moving backwards
## get_location(exact)
`get_location(exact): table` \
`get_location(exact): table[]` \
Get a list representing the symbol path to the current location.
| Param | Type | Desc |
| ----- | -------------- | ---------------------------------------------------------------------------------------------------------------- |
| exact | `nil\|boolean` | If true, only return symbols if we are exactly inside the hierarchy. When false, will return the closest symbol. |
Returns:
| Type | Desc |
| ----- | ---- |
| table | [] |
**Note:**
<pre>
Returns empty list if none found or in an invalid buffer.