Skip to content

Commit

Permalink
Format the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Shougo committed Aug 11, 2023
1 parent 9b1aaa5 commit cc095fd
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 29 deletions.
14 changes: 7 additions & 7 deletions doc/ddc-filter-converter_kind_labels.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Authors: Shougo <Shougo.Matsu at gmail.com>
uga-rosa <uga6603 at gmail.com>
License: MIT license

CONTENTS *ddc-filter-converter_kind_labels-contents*
CONTENTS *ddc-filter-converter_kind_labels-contents*

Introduction |ddc-filter-converter_kind_labels-introduction|
Examples |ddc-filter-converter_kind_labels-examples|
Expand All @@ -13,14 +13,14 @@ FAQ |ddc-filter-converter_kind_labels-faq|


==============================================================================
INTRODUCTION *ddc-filter-converter_kind_labels-introduction*
INTRODUCTION *ddc-filter-converter_kind_labels-introduction*

This filter converts lsp kind label to your setting.
This converter is specifically disigned for "ddc-source-nvim-lsp".


==============================================================================
EXAMPLES *ddc-filter-converter_kind_labels-examples*
EXAMPLES *ddc-filter-converter_kind_labels-examples*
>
call ddc#custom#patch_global(#{
\ sourceOptions: #{
Expand All @@ -32,9 +32,9 @@ EXAMPLES *ddc-filter-converter_kind_labels-examples*
<

==============================================================================
PARAMS *ddc-filter-converter_kind_labels-params*
PARAMS *ddc-filter-converter_kind_labels-params*

*ddu-filter-converter_kind_labels-param-kindLabels*
*ddu-filter-converter_kind_labels-param-kindLabels*
kindLabels (|Dictionary|)
This represents your setting labels corresponding to lsp kind labels.
Each your setting apply to each label.
Expand Down Expand Up @@ -68,7 +68,7 @@ kindLabels (|Dictionary|)

Default: {}

*ddu-filter-converter_kind_labels-param-kindHlGroups*
*ddu-filter-converter_kind_labels-param-kindHlGroups*
kindHlGroups (|Dictionary|)
This represents your setting labels highlight corresponding to lsp
kind labels.
Expand All @@ -84,7 +84,7 @@ kindHlGroups (|Dictionary|)
==============================================================================
FREQUENTLY ASKED QUESTIONS (FAQ) *ddc-filter-converter_kind_labels-faq*

Q: I want to use "VScode" like icon.
Q: I want to use "VSCode" like icon.

A: You can setting like bellow.
>
Expand Down
22 changes: 11 additions & 11 deletions doc/ddc-filter-sorter_lsp-kind.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@
Author: uga-rosa <uga6603@gmail.com>
License: MIT License

CONTENTS *ddc-filter-sorter_lsp-kind-contents*
CONTENTS *ddc-filter-sorter_lsp-kind-contents*

Introduction |ddc-filter-sorter_lsp-kind-introduction|
Examples |ddc-filter-sorter_lsp-kind-examples|
Params |ddc-filter-sorter_lsp-kind-params|
Introduction |ddc-filter-sorter_lsp-kind-introduction|
Examples |ddc-filter-sorter_lsp-kind-examples|
Params |ddc-filter-sorter_lsp-kind-params|


==============================================================================
INTRODUCTION *ddc-filter-sorter_lsp-kind-introduction*
INTRODUCTION *ddc-filter-sorter_lsp-kind-introduction*

Sort source-nvim-lsp items by kinds.


==============================================================================
EXAMPLES *ddc-filter-sorter_lsp-kind-examples*
EXAMPLES *ddc-filter-sorter_lsp-kind-examples*
>
call ddc#custom#patch_global(#{
\ sourceOptions: #{
Expand All @@ -39,9 +39,9 @@ EXAMPLES *ddc-filter-sorter_lsp-kind-examples*
<

==============================================================================
PARAMS *ddc-filter-sorter_lsp-kind-params*
PARAMS *ddc-filter-sorter_lsp-kind-params*

*ddc-filter-sorter_lsp-kind-param-priority*
*ddc-filter-sorter_lsp-kind-param-priority*
priority (|List|)
The type is `(LspKind | LspKind[])[]` and LspKind is a union type.
>
Expand Down Expand Up @@ -74,9 +74,9 @@ priority (|List|)
<
The previous element has higher priority, and by making it an array,
multiple LspKinds can have the same priority. For example, in
|ddc-filter-sorter_lsp-kind-examples|, `Enum` has the highest priority,
followed by `Method` and `Function` with the same priority, then `Field`,
`Variable`, and so on.
|ddc-filter-sorter_lsp-kind-examples|, `Enum` has the highest
priority, followed by `Method` and `Function` with the same priority,
then `Field`, `Variable`, and so on.

Default: [
"Snippet",
Expand Down
22 changes: 11 additions & 11 deletions doc/ddc-source-nvim-lsp.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Authors: Shougo <Shougo.Matsu at gmail.com>
uga-rosa <uga6603 at gmail.com>
License: MIT license

CONTENTS *ddc-source-nvim-lsp-contents*
CONTENTS *ddc-source-nvim-lsp-contents*

Introduction |ddc-source-nvim-lsp-introduction|
Install |ddc-source-nvim-lsp-install|
Expand All @@ -14,13 +14,13 @@ FAQ |ddc-source-nvim-lsp-faq|


==============================================================================
INTRODUCTION *ddc-source-nvim-lsp-introduction*
INTRODUCTION *ddc-source-nvim-lsp-introduction*

This source collects items from "nvim-lsp".


==============================================================================
INSTALL *ddc-source-nvim-lsp-install*
INSTALL *ddc-source-nvim-lsp-install*

Please install both "ddc.vim" and "denops.vim".

Expand All @@ -44,7 +44,7 @@ https://github.com/matsui54/denops-popup-preview.vim


==============================================================================
EXAMPLES *ddc-source-nvim-lsp-examples*
EXAMPLES *ddc-source-nvim-lsp-examples*

To take advantage of all the features, you need to set client_capabilities.

Expand Down Expand Up @@ -77,9 +77,9 @@ To take advantage of all the features, you need to set client_capabilities.
<

==============================================================================
PARAMS *ddc-source-nvim-lsp-params*
PARAMS *ddc-source-nvim-lsp-params*

*ddc-source-nvim-lsp-param-snippetEngine*
*ddc-source-nvim-lsp-param-snippetEngine*
snippetEngine (string | function)
The language server may return snippet as items, so work with
another plugin to expand it. Register with
Expand Down Expand Up @@ -108,22 +108,22 @@ snippetEngine (string | function)
<
Default: ""

*ddc-source-nvim-lsp-param-snippetIndicator*
snippetIndicator (string)
*ddc-source-nvim-lsp-param-snippetIndicator*
snippetIndicator (string)
The indicator string for snippet items added to the end of
a completion item.

NOTE: This affects ddc-item-attribute-abbr.

Default: "~"

*ddc-source-nvim-lsp-param-enableResolveItem*
*ddc-source-nvim-lsp-param-enableResolveItem*
enableResolveItem (boolean)
Enable LSP's "completionItem/resolve" feature.

Default: v:false

*ddc-source-nvim-lsp-param-enableAdditionalTextEdit*
*ddc-source-nvim-lsp-param-enableAdditionalTextEdit*
enableAdditionalTextEdit (boolean)
Enable supplementary editing apart from the cursor. For
instance, it allows the auto-import of the
Expand All @@ -135,7 +135,7 @@ enableAdditionalTextEdit (boolean)

Default: v:false

*ddc-source-nvim-lsp-param-confirmBehavior*
*ddc-source-nvim-lsp-param-confirmBehavior*
confirmBehavior ("insert" | "replace")
- "insert": Inserts the selected item and moves adjacent
text to the right.
Expand Down

0 comments on commit cc095fd

Please sign in to comment.