mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-21 00:25:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: remove misleading _ after globalPrefix

Browse source 
`globalPrefix` is not joined using `"_"`, so it is misleading to have an
underscore after it in CONTRIBUTING.md.
This commit is contained in:
Matt Sturgeon 2024-03-22 09:49:45 +00:00 • committed by Gaétan Lepage
parent 4f6e90212c
commit 80a2244afc
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -61,7 +61,7 @@ There are a number of helpers to help you correctly implement them:
- `helpers.nixvimTypes.rawLua`: A type to represent raw lua code. The values are of the form `{ __raw = "<code>";}`. This should not be used if the option can only be raw lua code, `mkLua`/`mkLuaFn` should be used in this case.
The resulting `settings` attrs will be directly translated to `lua` and will be forwarded the plugin:
- Using globals (`vim.g.<globalPrefix>_<option-name>`) for plugins using `mkVimPlugin`
- Using globals (`vim.g.<globalPrefix><option-name>`) for plugins using `mkVimPlugin`
- Using the `require('<plugin>').setup()` function for the plugins using `mkNeovimPlugin`
In either case, you don't need to bother implementing this part. It is done automatically.