|
1 | | -============================================================================== |
2 | | ------------------------------------------------------------------------------- |
3 | | - *CopyPythonPath.toggle()* |
4 | | - `CopyPythonPath.toggle`() |
5 | | -Toggle the plugin by calling the `enable`/`disable` methods respectively. |
6 | | - |
7 | | ------------------------------------------------------------------------------- |
8 | | - *CopyPythonPath.enable()* |
9 | | - `CopyPythonPath.enable`({scope}) |
10 | | -Initializes the plugin, sets event listeners and internal state. |
11 | | - |
12 | | ------------------------------------------------------------------------------- |
13 | | - *CopyPythonPath.disable()* |
14 | | - `CopyPythonPath.disable`() |
15 | | -Disables the plugin, clear highlight groups and autocmds, closes side buffers and resets the internal state. |
16 | | - |
17 | | - |
18 | | -============================================================================== |
19 | | ------------------------------------------------------------------------------- |
20 | | - *CopyPythonPath.options* |
21 | | - `CopyPythonPath.options` |
22 | | -CopyPythonPath configuration with its default values. |
23 | | - |
24 | | -Type ~ |
25 | | -`(table)` |
26 | | -Default values: |
27 | | ->lua |
28 | | - CopyPythonPath.options = { |
29 | | - -- Prints useful logs about what event are triggered, and reasons actions are executed. |
30 | | - debug = false, |
31 | | - } |
32 | | - |
33 | | -< |
34 | | ------------------------------------------------------------------------------- |
35 | | - *CopyPythonPath.setup()* |
36 | | - `CopyPythonPath.setup`({options}) |
37 | | -Define your copy-python-path setup. |
38 | | - |
39 | | -Parameters ~ |
40 | | -{options} `(table)` Module config table. See |CopyPythonPath.options|. |
41 | | - |
42 | | -Usage ~ |
43 | | -`require("copy-python-path").setup()` (add `{}` with your |CopyPythonPath.options| table) |
44 | | - |
45 | | - |
46 | | - vim:tw=78:ts=8:noet:ft=help:norl: |
0 commit comments