Skip to content

Commit

Permalink
Update the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Shougo committed Oct 12, 2021
1 parent 3c75dad commit e1f2e76
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions doc/ddc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -449,9 +449,9 @@ documentation instead.

*ddc-source-option-converters*
converters (string[])
It is a list of registered filter names that used with this
source. Candidates will be processed in the order you specify
here.
It is a list of registered filter names to change candidates
attributes.
Candidates will be processed in the order you specify here.

Default: []

Expand Down Expand Up @@ -515,9 +515,9 @@ matcherKey (string)

*ddc-source-option-matchers*
matchers (string[])
It is a list of registered filter names that used with this
source. Candidates will be processed in the order you specify
here.
It is a list of registered filter names to filter candidates
by user input.
Candidates will be processed in the order you specify here.

Default: []

Expand All @@ -529,9 +529,8 @@ minAutoCompleteLength (number)

*ddc-source-option-sorters*
sorters (string[])
It is a list of registered filter names that used with this
source. Candidates will be processed in the order you specify
here.
It is a list of registered filter names to sort candidates.
Candidates will be processed in the order you specify here.

Default: []

Expand All @@ -558,6 +557,12 @@ Once candidates have been supplied by one or more sources, they are passed
through the filters, which are matchers, converters or sorters. Sources can
have specific filters.

matchers: To filter candidates by user input
sorters: To sort candidates
converters: To change candidates attributes

Call order is matchers -> sorters -> converters

Note: The filters are not bundled in ddc.vim. You need to install them
to use ddc.vim. Please search them by https://github.com/topics/ddc-filter

Expand Down

0 comments on commit e1f2e76

Please sign in to comment.