From 826878c41e546a93919aba08e5a134433222b3a5 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 1 Mar 2021 21:38:11 +0000 Subject: [PATCH] Update documentation for floating window borders --- README.md | 6 +++++- doc/ale.txt | 8 ++++---- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4d375d16..2e6171c7 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,7 @@ other content at [w0rp.com](https://w0rp.com). 18. [How can I configure ALE differently for different buffers?](#faq-buffer-configuration) 19. [How can I configure the height of the list in which ALE displays errors?](#faq-list-window-height) 20. [How can I run linters or fixers via Docker or a VM?](#faq-vm) + 21. [How can I change the borders for floating preview windows?](#faq-window-borders) @@ -908,6 +909,8 @@ correct commands and map filename paths between different file systems. See `:help ale-lint-other-machines` for the full documentation on how to configure ALE to support this. + + ### 5.xxi. How can I change the borders for floating preview windows? Borders for floating preview windows are enabled by default. You can use the @@ -919,7 +922,8 @@ You could disable the border with an empty list. let g:ale_floating_window_border = [] ``` -If the terminal supports Unicode, you might try setting the value like below, to make it look nicer. +If the terminal supports Unicode, you might try setting the value like below, to +make it look nicer. ```vim let g:ale_floating_window_border = ['│', '─', '╭', '╮', '╯', '╰'] diff --git a/doc/ale.txt b/doc/ale.txt index c87b05e2..0fc95ae0 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -653,7 +653,7 @@ Hover information can be displayed in the preview window instead by setting |g:ale_hover_to_preview| to `1`. When using Neovim, if |g:ale_hover_to_floating_preview| or |g:ale_floating_preview| -is set to 1, the hover information will show in a floating window. And +is set to 1, the hover information will show in a floating window. And |g:ale_floating_window_border| for the border setting. For Vim 8.1+ terminals, mouse hovering is disabled by default. Enabling @@ -1211,9 +1211,9 @@ g:ale_floating_window_border *g:ale_floating_window_border Type: |List| Default: `['|', '-', '+', '+', '+', '+']` - When set to `[]`, window borders are disabled. The elements in the list - set the horizontal, top, top-left, top-right, bottom-right - and bottom-left border characters, respectively. + When set to `[]`, window borders are disabled. The elements in the list set + the horizontal, top, top-left, top-right, bottom-right and bottom-left + border characters, respectively. If the terminal supports Unicode, you might try setting the value to ` ['│', '─', '╭', '╮', '╯', '╰']`, to make it look nicer.