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

fix some README grammar (#136)

Browse Source
This commit is contained in:
Stephen Brown-Bourne
2021-09-01 23:12:59 -07:00
committed by GitHub
parent cf70aafdba
commit 1ae7b5e250
1 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -33,9 +33,9 @@ Setup
## Install ## Install
First, You should install `nvim-cmp` itself and completion sources and snippet engine by your favourite plugin manager. First, You should install `nvim-cmp` itself and completion sources and snippet engine with your favourite plugin manager.
The `nvim-cmp` sources can be found in [here](https://github.com/topics/nvim-cmp). The `nvim-cmp` sources can be found [here](https://github.com/topics/nvim-cmp).
Using [vim-plug](https://github.com/junegunn/vim-plug): Using [vim-plug](https://github.com/junegunn/vim-plug):
@@ -65,7 +65,7 @@ use {
## Basic Configuration ## Basic Configuration
First, You should do the following steps. First, you should do the following steps.
- You must set `snippet engine` up. See README.md of your choosen snippet engine. - You must set `snippet engine` up. See README.md of your choosen snippet engine.
- Remove `longest` from `completeopt`. See `:help completeopt`. - Remove `longest` from `completeopt`. See `:help completeopt`.
@@ -92,7 +92,7 @@ lua <<EOF
EOF EOF
``` ```
The default configuration can be found in [here](./lua/cmp/config/default.lua) The default configuration can be found [here](./lua/cmp/config/default.lua)
Advanced Configuration Advanced Configuration
==================== ====================
@@ -131,7 +131,7 @@ EOF
``` ```
The configuration options will be merged with the default config. The configuration options will be merged with the default config.
If you want to remove the option, You can set the `false` instead. If you want to remove an option, you can set it to `false` instead.
#### mapping (type: table<string, fun(fallback: function)>) #### mapping (type: table<string, fun(fallback: function)>)
@@ -440,20 +440,20 @@ cmp.setup {
I've optimized `nvim-cmp` as much as possible, but there are currently some known / unfixable issues. I've optimized `nvim-cmp` as much as possible, but there are currently some known / unfixable issues.
1. `cmp-buffer` source and too large buffer 1. `cmp-buffer` source and too large buffer.
The `cmp-buffer` source makes index of the current buffer so if the current buffer is too large, will be slowdown main UI thread. The `cmp-buffer` source makes an index of the current buffer so if the current buffer is too large, it will slowdown the main UI thread.
1. some language servers 1. Some language servers.
For example, `typescript-language-server` will returns 15k items to the client. For example, `typescript-language-server` will returns 15k items to the client.
In such case, the time near the 100ms will be consumed just to parse payloads as JSON. In such a case, it will take 100ms just to parse payloads as JSON.
1. You set `vim.lsp.set_log_level` up by yourself. 1. You set `vim.lsp.set_log_level` up by yourself.
This setting will cause the filesystem operation for each LSP payloads. This setting will cause the filesystem operation for each LSP payload.
This will extremely slow down nvim-cmp (and other LSP related features). This will greatly slow down nvim-cmp (and other LSP related features).
#### How to setup supertab-like mapping? #### How to setup supertab-like mapping?
This is supertab-like mapping for [LuaSnip](https://github.com/L3MON4D3/LuaSnip) This is a supertab-like mapping for [LuaSnip](https://github.com/L3MON4D3/LuaSnip)
```lua ```lua
local check_back_space = function() local check_back_space = function()
@@ -522,7 +522,7 @@ formatting = {
Source creation Source creation
==================== ====================
Warning: If the LSP spec is changed, nvim-comp will keep up to it without announcement. Warning: If the LSP spec is changed, nvim-comp will keep up to it without an announcement.
If you publish `nvim-cmp` source to GitHub, please add `nvim-cmp` topic for the repo. If you publish `nvim-cmp` source to GitHub, please add `nvim-cmp` topic for the repo.