Skip to content
This repository was archived by the owner on Oct 1, 2020. It is now read-only.

Commit 08ea270

Browse files
committed
Clarify documentation for autoclose option.
It doesn't "close the quickfix window automatically". I'm not even sure what that is supposed to mean. It does not open the window when there are no errors, and closes the existing window if there previously were but now aren't. I think.
1 parent 3bd879d commit 08ea270

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ Jump to the definition of the variable under the cursor.
6767

6868
#### `g:flow#autoclose`
6969

70-
If this is set to `1`, the |quickfix| window opened when the plugin finds an error
71-
will close automatically.
70+
If this is set to `1`, the quickfix window will not be opened when there are
71+
no errors, and will be automatically closed when previous errors are cleared.
7272

7373
Default is `0`.
7474

doc/vim-flow.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ VARIABLES *vim-flow-variables*
1111

1212
g:flow#autoclose *g:flow#autoclose*
1313

14-
If this is set to 1, the |quickfix| window opened when the plugin finds an error
15-
will close automatically.
14+
If this is set to 1, the |quickfix| window will not be opened when there are
15+
no errors, and will be automatically closed when previous errors are cleared.
1616

1717
Default is 0.
1818

plugin/flow.vim

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ let g:loaded_flow = 1
77

88
" Configuration switches:
99
" - enable: Typechecking is done on :w.
10-
" - autoclose: Quickfix window closes automatically.
10+
" - autoclose: Quickfix window closes automatically when there are no errors.
1111
" - errjmp: Jump to errors after typechecking; default off.
1212
" - qfsize: Let the plugin control the quickfix window size.
1313
" - flowpath: Path to the flow executable - default is flow in path

0 commit comments

Comments
 (0)