Document Issue #11.

dstein64 · Jan 3, 2021 · 057ec56 · 057ec56
1 parent 7be40b0
commit 057ec56
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/doc/scrollview.txt b/doc/scrollview.txt
@@ -129,6 +129,8 @@ following example.
 ============================================================================
 5. Issues                                  *scrollview-issues*
 
+Synchronization Issues ~
+                                           *scrollview-synchronization-issues*
 * Scrollbars can become out-of-sync after window arrangement actions that are
   not followed by a scroll event. For example, this can be seen by starting
   `nvim`, issuing |:help|, then typing `<ctrl-w>J` to move the help window to
@@ -152,6 +154,16 @@ following example.
     nnoremap <silent> <scrollwheeldown>
           \ <scrollwheeldown>:silent! ScrollViewRefresh<cr>
 
+* Scrollbars become out-of-sync after fold commands when using a
+  |scrollview-mode| that accounts for folds. Because there are no |autocmd-events|
+  for folding, the plugin is unable to refresh the scrollbars.
+  - Workaround: Remap the problematic fold command key sequences accordingly,
+    depending on the fold commands you use. >
+    nnoremap <silent> zo zo:silent! ScrollViewRefresh<cr>
+    nnoremap <silent> zc zc:silent! ScrollViewRefresh<cr>
+
+Error Message Issues ~
+                                           *scrollview-error-message-issues*
 * When attempting to close the last window in a tab with |:close| or
   `<ctrl-w>c`, with the scrollbar displayed, and at least one other tab, the
   following error is shown: >

diff --git a/doc/tags b/doc/tags
@@ -5,10 +5,12 @@ flexible	scrollview.txt	/*flexible*
 nvim-scrollview	scrollview.txt	/*nvim-scrollview*
 scrollview-color-customization	scrollview.txt	/*scrollview-color-customization*
 scrollview-configuration	scrollview.txt	/*scrollview-configuration*
+scrollview-error-message-issues	scrollview.txt	/*scrollview-error-message-issues*
 scrollview-installation	scrollview.txt	/*scrollview-installation*
 scrollview-issues	scrollview.txt	/*scrollview-issues*
 scrollview-modes	scrollview.txt	/*scrollview-modes*
 scrollview-requirements	scrollview.txt	/*scrollview-requirements*
+scrollview-synchronization-issues	scrollview.txt	/*scrollview-synchronization-issues*
 scrollview-usage	scrollview.txt	/*scrollview-usage*
 scrollview.txt	scrollview.txt	/*scrollview.txt*
 scrollview_base	scrollview.txt	/*scrollview_base*