vim/vim-airline
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

tidy up documentation

Browse Source
This commit is contained in:
Bailey Ling 2013-09-07 18:33:47 +00:00
parent 697e08a83c
commit 9c416f28d4
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/airline.txt
View File

@ -71,7 +71,8 @@ values):
endif endif
endfunction endfunction
< <
* enable/disable automatic selection of patched powerline font symbols > * enable/disable automatic population of the `g:airline_symbols` dictionary
with powerline symbols.
let g:airline_powerline_fonts=0 let g:airline_powerline_fonts=0
< <
* define the set of text to display for each mode. > * define the set of text to display for each mode. >
@ -387,10 +388,10 @@ define a section like this: >
< <
This will create a section with the `mode`, followed by a space, and our `foo` This will create a section with the `mode`, followed by a space, and our `foo`
part in section `a`. Section `b` will have two parts with a left-side part in section `a`. Section `b` will have two parts with a left-side
separator. And section`c` will contain the current path. You may notice that separator. And section `c` will contain the current path. You may notice that
the space and cwd are not defined to be parts. For convenience, if a part of the space and cwd are not defined parts. For convenience, if a part of that
that key does not exist, it will be inserted as is. The unit tests will be a key does not exist, it will be inserted as is. The unit tests will be a good
good resource for possibilities. resource for possibilities.
Note: The use of `VimEnter` is important, because most extensions are lazily Note: The use of `VimEnter` is important, because most extensions are lazily
loaded, so we must give them a chance to define their parts before we can use loaded, so we must give them a chance to define their parts before we can use
@ -398,9 +399,9 @@ them.
Note: The `airline#section#create` function and friends will do its best to Note: The `airline#section#create` function and friends will do its best to
create a section with the appropriate separators, but it only works for create a section with the appropriate separators, but it only works for
function and text parts. Special |statusline| items like %f or raw parts will function and text parts. Special |statusline| items like %f or raw/undefined
not work as it is not possible to inspect their widths/contents before parts will not work as it is not possible to inspect their widths/contents
rendering to the statusline. before rendering to the statusline.
============================================================================== ==============================================================================
FUNCREFS *airline-funcrefs* FUNCREFS *airline-funcrefs*