Skip to content

Commit

Permalink
Improve the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Shougo committed Mar 23, 2024
1 parent 7a2f3e3 commit cdb9400
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions doc/dpp.txt
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,8 @@ dpp#get([{plugin-name}])

*dpp#make_state()*
dpp#make_state({base-path}, {config-path}[, {name}])
Save dpp's state in the cache script.
Save dpp's state and generate startup script from
{config-path}.
{base-path} is where your downloaded plugins will be placed.
{config-path} is TypeScript configuration file path to make
state. It must be full path.
Expand All @@ -181,15 +182,16 @@ dpp#make_state({base-path}, {config-path}[, {name}])

*dpp#min#load_state()*
dpp#min#load_state({base-path}[, {name}])
Load dpp's state from the cache script, {base-path} is where
your downloaded plugins will be placed.
Load dpp's state and execute startup script generated by
|dpp#make_state()|, {base-path} is where your downloaded
plugins will be placed.
{name} is plugins profile name. The default is "vim" or
"nvim".
NOTE: It overwrites your 'runtimepath' completely, you must
not call it after change 'runtimepath' dynamically.
NOTE: The block is skipped if dpp's state is loaded.

It returns 1, if the cache script is old or invalid or not
It returns 1, if the startup script is old or invalid or not
found.
*dpp#source()*
dpp#source([{name}])
Expand Down

0 comments on commit cdb9400

Please sign in to comment.