diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/julia-vim.txt | 87 | ||||
| -rw-r--r-- | doc/vim-go.txt | 49 |
2 files changed, 133 insertions, 3 deletions
diff --git a/doc/julia-vim.txt b/doc/julia-vim.txt index 3f09e3bd..5cf181d0 100644 --- a/doc/julia-vim.txt +++ b/doc/julia-vim.txt @@ -349,7 +349,7 @@ julia#function_assign2block() statements are removed; if the result is empty, `nothing` is substituted. Leading macros (e.g. `@inline` or `@compat`) are recognized and preserved by the transformation. - + In order to make this functionality practical, it is advisable to map it to some key combination, e.g.: > @@ -386,6 +386,91 @@ g:julia_highlight_operators Determines whether to apply syntax highlighting to operators. Default: on (set to `1`). + *g:julia_indent_align_import* +g:julia_indent_align_import + + In a multi-line import/using/export statment, the lines after + the first one use some special alignment rules by default, + e.g.: +> + import X: one, + two, + three + export four, + five, + six +< + When `g:julia_indent_align_import` is `0` instead, the usual + indentation is used: +> + import X: one, + two, + three + export four, + five, + six + + *g:julia_indent_align_brackets* +g:julia_indent_align_brackets + + In a multi-line bracketed expression (except for function + arguments, see |g:julia_indent_align_funcargs|), the lines + after the first one use some special alignment rules by + default, e.g.: +> + matrix = [1 2 3; + 4 5 6] + tpl = ( + abc = Dict(a=>1, + b=>2), + def = [1 2; + 3 4], + xyz = SubArray{eltype(P), + N, P, I, + false} + ) +< + When `g:julia_indent_align_brackets` is `0` instead, an extra + indent is used: +> + matrix = [1 2 3; + 4 5 6] + tpl = ( + abc = Dict(a=>1, + b=>2), + def = [1 2; + 3 4], + xyz = SubArray{eltype(P), + N, P, I, + false} + ) +< + + *g:julia_indent_align_funcargs* +g:julia_indent_align_funcargs + + In a function definition, when the arguments span multiple + lines, the lines after the first one get an extra indentation + step by default, e.g.: +> + function functionanme( + arg1, arg2, + arg3, arg4 + ) + # function body + end +< + By setting `g:julia_indent_align_funcargs` to `1`, the + arguments are aligned to the bracket instead (they work as any + other bracket with the default value of + |g:julia_indent_align_brackets|): +> + function functionanme(arg1, arg2, + arg3, arg4 + ) + # function body + end +< ============================================================================== ABOUT *julia-vim-about* diff --git a/doc/vim-go.txt b/doc/vim-go.txt index cc412836..d33a8b38 100644 --- a/doc/vim-go.txt +++ b/doc/vim-go.txt @@ -1498,9 +1498,9 @@ other packages. Valid options are `gopls` and `guru`. By default it's `gopls`. Use this option to define the command to be used for |:GoImplements|. The Implements feature in gopls is still new and being worked upon. -Valid options are `gopls` and `guru`. By default it's `guru`. +Valid options are `gopls` and `guru`. By default it's `gopls`. > - let g:go_implements_mode = 'guru' + let g:go_implements_mode = 'gopls' < *'g:go_def_mapping_enabled'* @@ -2490,7 +2490,52 @@ Show only variables on the right-hand side: > let g:go_debug_windows = { \ 'vars': 'rightbelow 60vnew', \ } + + *'g:go_debug_mappings'* + +Contains custom key mapping information to customize the active mappings +when debugging. + +Only the customizations desired need to be provided; the debugger will use its +default key mappings for any mapping not defined here. + +This value should be a dictionary whose keys are the plugin mapping commands +(e.g. `(go-debug-continue)`). The values are dictionaries with two keys. +`key` and `attributes`. + +`key` is expected to be the key to map (i.e. it's the `lhs` in a mapping). +`key` can be empty or missing to prevent a key mapping from being applied for +one the named mappings. + +`arguments` is the string of `map-arguments` for the mapping (e.g. +`<nowait>`). + +The first item must be the `lhs` to use for the mapping. The optional +second item is for `:map-arguments`. All mappings will always be `:map-local`, +so there is never a need to include `"<buffer>"` in the the arguments. +> + let g:go_debug_mappings = { + \ '(go-debug-continue)': {'key': 'c', 'arguments': '<nowait>'], + \ '(go-debug-stop)': {'key': 'q'}, + \ '(go-debug-next)': {'key': 'n', 'arguments': '<nowait>'}, + \ '(go-debug-step)': {'key': 's'}, + \} < + +Defaults are equivalent to: +> + let g:go_debug_mappings = { + \ '(go-debug-continue)': {'key': '<F5>'}, + \ '(go-debug-print)': {'key': '<F6>'}, + \ '(go-debug-breakpoint)': {'key': '<F9>'}, + \ '(go-debug-next)': {'key': '<F10>'}, + \ '(go-debug-step)': {'key': '<F11>'}, + \ '(go-debug-halt)': {'key': '<F8>'}, + \ } +< + +Your user specified settings will be merged with the defaults. + *'g:go_debug_address'* Server address `dlv` will listen on; must be in `hostname:port` format. |