rob
/
lualine.nvim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix doc typos (#72)

This commit is contained in:
Jim Tittsler 2021-09-28 17:05:10 +09:00 committed by GitHub
parent 4353afd1de
commit 05314de43a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
BREAKING_CHANGES.md
View File

@ -1,7 +1,7 @@
This file contains braking changes that have been made in this branch to This file contains breaking changes that have been made in this branch to
make it easier to switch from [hoob3rt/lualine.nvim](https://github.com/hoob3rt/lualine.nvim) make it easier to switch from [hoob3rt/lualine.nvim](https://github.com/hoob3rt/lualine.nvim)
In this file contains changes in timed order . It's possible breaking change This file contains changes in chronological order. It's possible breaking change
has been made to several times to same thing . In that case the one in the has been made several times to the same thing. In that case the one nearest the
bottom indicates current state. bottom indicates current state.
### Color option unification ### Color option unification
@ -18,10 +18,10 @@ You'll have
```lua ```lua
color_added = { fg = '#rrbbgg' } color_added = { fg = '#rrbbgg' }
``` ```
for same effect. for the same effect.
### Theme rename ### Theme rename
So themes were renamed so they are same as their `g:color_name` Some themes were renamed so they are same as their `g:color_name`
- oceanicnext -> OceanicNext - oceanicnext -> OceanicNext
- papercolor -> PaperColor - papercolor -> PaperColor
- tomorrow -> Tomorrow - tomorrow -> Tomorrow
@ -29,18 +29,18 @@ So themes were renamed so they are same as their `g:color_name`
- modus_vivendi -> modus-vivendi - modus_vivendi -> modus-vivendi
### function components now receive some default parameters ### function components now receive some default parameters
Now function components receive same args as `update_status`. So fuctions Now function components receive the same args as `update_status`. So the function
signature is now signature is now:
```lua ```lua
function(self, is_active) function(self, is_active)
``` ```
`self` is a table that represents the component in lualine & `is_active` is `self` is a table that represents the component in lualine & `is_active` is
a boolean value that indicates whether the function is being evaluated a boolean value that indicates whether the function is being evaluated
for active statusline or inactive statusline. This means function components for an active statusline or an inactive statusline. This means function components
can be more versatile. But also means you can't use functions that take can be more versatile. But it also means you can't use functions that take
optional arguments directly as function component. `lsp_status` is such optional arguments directly as function component. `lsp_status` is such
a cases it takes an optional `winid` in first argument . a case that takes an optional `winid` in its first argument.
You can wrap it with a function so those self & is_active doesn't You can wrap it with a function so the `self` & `is_active` don't
get passed to `lsp_status` get passed to `lsp_status`
```lua ```lua
lualine_c = { function() return require'lsp-status'.status() end} lualine_c = { function() return require'lsp-status'.status() end}
@ -52,7 +52,7 @@ See [#24](https://github.com/shadmansaleh/lualine.nvim/pull/24) for details
- separators are specified by left & right instead of position - separators are specified by left & right instead of position
instead of `{'>', '<'}` you'll use `{left= '>', right='<'}`. instead of `{'>', '<'}` you'll use `{left= '>', right='<'}`.
- `left_padding` & `right_padding` removed. You can specify left or right - `left_padding` & `right_padding` removed. You can specify left or right
padding with padding option like padding = `{ left = 5 }` padding with a padding option like padding = `{ left = 5 }`
- Option rename: - Option rename:
- condition -> cond - condition -> cond
- format -> fmt - format -> fmt