Skip to content

Commit bb6e0e9

Browse files
committed
📖 docs: Add undocumented functions
1 parent a041c59 commit bb6e0e9

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

‎doc/readme_viewer.txt

+28-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,34 @@ COMMANDS *readme-viewer-commands*
7676
------------------------------------------------------------------------------
7777
FUNCTIONS *readme-viewer-functions*
7878

79-
Undocumented now
79+
*readme_viewer#dein#get()*
80+
*readme_viewer#plug#get()*
81+
*readme_viewer#minpac#get()*
82+
readme_viewer#{plugin-manager}#get([{plugin-name}])
83+
Get the plugin information dictionary. If you omit {plugin-name},
84+
vim-readme-viewer will return the all of plugins directory. Its key is
85+
the plugin name and its value is the plugin information dictionary.
86+
87+
readme_viewer#get([{plugin-name}]) *readme_viewer#get()*
88+
Get the plugin information dictionary. It is alias of current plugin
89+
manager's `get` function. Please see above.
90+
91+
*readme_viewer#dein#open()*
92+
*readme_viewer#plug#open()*
93+
*readme_viewer#minpac#open()*
94+
readme_viewer#{plugin-manager}#open({plugin}, {mods})
95+
Open {plugin}'s README file. {mods} is command modifiers. (e.g.
96+
"vertical topleft")
97+
98+
readme_viewer#open({plugin}, {mods}) *readme_viewer#open()*
99+
Open {plugin}'s README file. {mods} is command modifiers. It is alias
100+
of current plugin manager's `open` function. Please see above.
101+
102+
*readme_viewer#open_buffer()*
103+
readme_viewer#open_buffer({path}, {name} [, {mods}])
104+
Open {plugin}'s README file. {mods} is command modifiers. (e.g.
105+
"vertical topleft") Difference from |readme_viewer#open()| is to
106+
handle error or not.
80107

81108
------------------------------------------------------------------------------
82109
VARIABLES *readme-viewer-variables*

0 commit comments

Comments
 (0)