Skip to content

Commit

Permalink
Improve the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Shougo committed Jul 30, 2023
1 parent 899c1bc commit 3f6643f
Showing 1 changed file with 12 additions and 23 deletions.
35 changes: 12 additions & 23 deletions doc/ddu.txt
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,18 @@ INTERFACE *ddu-interface*
------------------------------------------------------------------------------
OPTIONS *ddu-options*

There're 4 layers of options for the ddu.vim in order of priority:

user: set by |ddu#start()| or |ddu#get_items()|.
local: set by |ddu#custom#patch_local()| with a name.
global: set by |ddu#custom#patch_global()|.
default: as described in each |ddu-options|.

ddu.vim merges them recursively.

The |ddu-option-name| describes the name which local option be used.
And |ddu-option-name| value is also decided by user, global and
default options.
*ddu-option-actionOptions*
actionOptions (dictionary)
It is a dictionary that maps action names to its options.
Expand Down Expand Up @@ -466,9 +478,6 @@ ddu#custom#load_config({path})
NOTE: {path} must be full path.
NOTE: The loading is asynchronous.

*ddu#custom#load_extensions()*
ddu#custom#load_extensions({path})

*ddu#custom#patch_global()*
ddu#custom#patch_global({option-name}, {value})
ddu#custom#patch_global({dict})
Expand Down Expand Up @@ -1355,9 +1364,6 @@ FAQ 6: |ddu-faq-6|
FAQ 7: |ddu-faq-7|
I want to execute grep action from items.

FAQ 8: |ddu-faq-8|
How ddu.vim use options?


------------------------------------------------------------------------------
*ddu-faq-1*
Expand Down Expand Up @@ -1437,23 +1443,6 @@ A: The example is here. >
\ })
endfunction
<
*ddu-faq-8*
Q: How ddu.vim use options?

There're 4 layers of options for the ddu.vim in the order of the
priority:

user: set by |ddu#start()| or |ddu#get_items()|.
local: set by |ddu#custom#patch_local()| with a name.
global: set by |ddu#custom#patch_global()|.
default: as described in each |ddu-options|.

ddu.vim merges them recursively.

The |ddu-option-name| describes the name which local option be used.
And |ddu-option-name| value is also decided by user, global and
default options.


==============================================================================
COMPATIBILITY *ddu-compatibility*
Expand Down

0 comments on commit 3f6643f

Please sign in to comment.