Improve the documentation

yast · Mar 9, 2020 · 6167ebb · 6167ebb
1 parent d5e1be8
commit 6167ebb
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/library/cwm/src/lib/cwm/common_widgets.rb b/library/cwm/src/lib/cwm/common_widgets.rb
@@ -368,6 +368,13 @@ class RichText < AbstractWidget
 
     # Determines if the vertical scroll must be kept after updating the content
     #
+    # @note Useful only to keep the sense of continuity when redrawing basically with the same text
+    #
+    # Keeping the vertical scroll after changing the value is mostly intended to be used after a
+    # redraw because of a user action. However, using it after changing the content noticeably
+    # (e.g., displaying different product descriptions), will look like a randomly positioned
+    # vertical scroll.
+    #
     # @return [Boolean] true if the vertical scroll must be kept; false otherwise
     def keep_scroll?
       false