RepoMirrors/ale
1
0
Fork 0
mirror of https://github.com/dense-analysis/ale synced 2025-02-04 14:32:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up documentation typos and formatting

Browse Source
This commit is contained in:
w0rp 2023-09-09 15:40:30 +01:00
parent d2c2bbf2dc
commit 0a135456a6
No known key found for this signature in database
GPG Key ID: 0FC1ECAA8C81CD83
1 changed files with 16 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
doc/ale.txt
View File

@ -737,6 +737,7 @@ You may wish to remove some other menu items you don't want to see: >
===============================================================================
6. Global Options *ale-options*
g:airline#extensions#ale#enabled *g:airline#extensions#ale#enabled*
Type: |Number|
@ -881,7 +882,7 @@ g:ale_completion_autoimport *g:ale_completion_autoimport*
When this option is set to `1`, ALE will try to automatically import
completion results from external modules. It can be disabled by setting it
to `0`. Some LSP servers include auto imports on every completion item so
disabling automatic imports may drop some or all completion items returnend
disabling automatic imports may drop some or all completion items returned
by it (e.g. eclipselsp).
@ -960,6 +961,7 @@ g:ale_completion_max_suggestions *g:ale_completion_max_suggestions*
Adjust this option as needed, depending on the complexity of your codebase
and your available processing power.
g:ale_cursor_detail *g:ale_cursor_detail*
Type: |Number|
@ -1113,7 +1115,6 @@ g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str*
g:ale_enabled *g:ale_enabled*
*b:ale_enabled*
Type: |Number|
Default: `1`
@ -1134,7 +1135,6 @@ g:ale_enabled *g:ale_enabled*
g:ale_exclude_highlights *g:ale_exclude_highlights*
*b:ale_exclude_highlights*
Type: |List|
Default: `[]`
@ -1149,7 +1149,6 @@ g:ale_exclude_highlights *g:ale_exclude_highlights*
g:ale_fixers *g:ale_fixers*
*b:ale_fixers*
Type: |Dictionary|
Default: `{}`
@ -1171,7 +1170,6 @@ g:ale_fixers *g:ale_fixers*
g:ale_fix_on_save *g:ale_fix_on_save*
*b:ale_fix_on_save*
Type: |Number|
Default: `0`
@ -1193,7 +1191,6 @@ g:ale_fix_on_save *g:ale_fix_on_save*
g:ale_fix_on_save_ignore *g:ale_fix_on_save_ignore*
*b:ale_fix_on_save_ignore*
Type: |Dictionary| or |List|
Default: `{}`
@ -1241,11 +1238,12 @@ g:ale_floating_preview_popup_opts *g:ale_floating_preview_popup_opts*
Type: |String| or |Dictionary|
Default: `''`
Either a dictionary of options or the string name of a function that returns a
dictionary of options. This will be used as an argument to |popup_create| for
Vim users or |nvim_open_win| for NeoVim users. Note that in either case, the
resulting dictionary is merged with ALE defaults rather than expliciting overriding
them. This only takes effect if |g:ale_floating_preview| is enabled.
Either a dictionary of options or the string name of a function that returns
a dictionary of options. This will be used as an argument to |popup_create|
for Vim users or |nvim_open_win| for NeoVim users. In either case, the
resulting dictionary is merged with ALE defaults rather than explicitly
overriding them. This only takes effect if |g:ale_floating_preview| is
enabled.
NOTE: for Vim users see |popup_create-arguments|, for NeoVim users see
|nvim_open_win| for argument details
@ -1266,16 +1264,16 @@ g:ale_floating_window_border *g:ale_floating_window_border*
Default: `['|', '-', '+', '+', '+', '+', '|', '-']`
When set to `[]`, window borders are disabled. The elements in the list set
the the characters for the left side, top, top-left corner, top-right
corner, bottom-right corner, bottom-left corner, right side, and bottom of
the floating window, respectively.
the characters for the left side, top, top-left corner, top-right
corner, bottom-right corner, bottom-left corner, right side, and bottom of
the floating window, respectively.
If the terminal supports Unicode, you might try setting the value to
` ['│', '─', '╭', '╮', '╯', '╰', '│', '─']`, to make it look nicer.
NOTE: For compatibility with previous versions, if the list does not have
elements for the right side and bottom, the left side and top will be used
instead.
elements for the right side and bottom, the left side and top will be used
instead.
g:ale_history_enabled *g:ale_history_enabled*
@ -1465,7 +1463,6 @@ g:ale_lint_on_text_changed *g:ale_lint_on_text_changed*
g:ale_lint_on_insert_leave *g:ale_lint_on_insert_leave*
*b:ale_lint_on_insert_leave*
Type: |Number|
Default: `1`
@ -1553,7 +1550,6 @@ g:ale_linter_aliases *g:ale_linter_aliases*
g:ale_filename_mappings *g:ale_filename_mappings*
*b:ale_filename_mappings*
Type: |Dictionary| or |List|
Default: `{}`
@ -1721,7 +1717,6 @@ g:ale_linters_explicit *g:ale_linters_explicit*
g:ale_linters_ignore *g:ale_linters_ignore*
*b:ale_linters_ignore*
Type: |Dictionary| or |List|
Default: `{}`
@ -1757,7 +1752,6 @@ g:ale_list_vertical *g:ale_list_vertical*
g:ale_loclist_msg_format *g:ale_loclist_msg_format*
*b:ale_loclist_msg_format*
Type: |String|
Default: `g:ale_echo_msg_format`
@ -1954,7 +1948,6 @@ g:ale_rename_tsserver_find_in_comments *g:ale_rename_tsserver_find_in_comments*
g:ale_rename_tsserver_find_in_strings *g:ale_rename_tsserver_find_in_strings*
Type: |Number|
Default: `0`
@ -1965,7 +1958,6 @@ g:ale_rename_tsserver_find_in_strings *g:ale_rename_tsserver_find_in_strings*
g:ale_root *g:ale_root*
*b:ale_root*
Type: |Dictionary| or |String|
Default: `{}`
@ -1994,7 +1986,6 @@ g:ale_save_hidden *g:ale_save_hidden*
g:ale_set_balloons *g:ale_set_balloons*
*b:ale_set_balloons*
Type: |Number| or |String|
Default: `has('balloon_eval') && has('gui_running')`
@ -2012,7 +2003,6 @@ g:ale_set_balloons *g:ale_set_balloons*
let g:ale_set_balloons = has('gui_running') ? 'hover' : 0
<
Balloons can be enabled for terminal versions of Vim that support balloons,
but some versions of Vim will produce strange mouse behavior when balloons
are enabled. To configure balloons for your terminal, you should first
@ -2163,7 +2153,6 @@ g:ale_sign_priority *g:ale_sign_priority*
g:ale_shell *g:ale_shell*
*b:ale_shell*
Type: |String|
Default: not set
@ -2181,7 +2170,6 @@ g:ale_shell *g:ale_shell*
g:ale_shell_arguments *g:ale_shell_arguments*
*b:ale_shell_arguments*
Type: |String|
Default: not set
@ -2412,6 +2400,7 @@ g:ale_virtualtext_maxcolumn *g:ale_virtualtext_maxcolumn*
When `column` is set to zero, column positioning is disabled, when `maxcolumn`
is set to zero, no maximum line length is enforced.
g:ale_virtualtext_single *g:ale_virtualtext_single*
*b:ale_virtualtext_single*
Type: |Number|
@ -2424,9 +2413,9 @@ g:ale_virtualtext_single *g:ale_virtualtext_single*
With `single` set to a non-zero value, only the first message appears.
(No attempt is made to prefer message types such as errors over warnings)
g:ale_virtualenv_dir_names *g:ale_virtualenv_dir_names*
*b:ale_virtualenv_dir_names*
Type: |List|
Default: `['.env', '.venv', 'env', 've-py3', 've', 'virtualenv', 'venv']`
@ -2440,7 +2429,6 @@ g:ale_virtualenv_dir_names *g:ale_virtualenv_dir_names*
g:ale_warn_about_trailing_blank_lines *g:ale_warn_about_trailing_blank_lines*
*b:ale_warn_about_trailing_blank_lines*
Type: |Number|
Default: `1`
@ -2452,7 +2440,6 @@ g:ale_warn_about_trailing_blank_lines *g:ale_warn_about_trailing_blank_lines*
g:ale_warn_about_trailing_whitespace *g:ale_warn_about_trailing_whitespace*
*b:ale_warn_about_trailing_whitespace*
Type: |Number|
Default: `1`
@ -2469,7 +2456,6 @@ g:ale_warn_about_trailing_whitespace *g:ale_warn_about_trailing_whitespace*
g:ale_windows_node_executable_path *g:ale_windows_node_executable_path*
*b:ale_windows_node_executable_path*
Type: |String|
Default: `'node.exe'`