branch: elpa/scroll-on-drag
commit a8de098705f279598f30c31b5ff66a8afdeb2bc4
Author: Campbell Barton <ideasma...@gmail.com>
Commit: Campbell Barton <ideasma...@gmail.com>
readme: minor updates & clarifications
---
readme.rst | 7 ++++++-
scroll-on-drag.el | 2 +-
2 files changed, 7 insertions(+), 2 deletions(-)
diff --git a/readme.rst b/readme.rst
index 840b79fedb..070b5d98c4 100644
--- a/readme.rst
+++ b/readme.rst
@@ -73,12 +73,17 @@ Customization
While the defaults seem to work well, these values can be customized.
+``scroll-on-drag-style``: ``'line-by-pixel``
+ The the method scrolling is calculated.
+
+ - ``'line-by-pixel`` Scrolling is calculated at a pixel level.
+ - ``'line`` Scrolling is calculated at line-level.
``scroll-on-drag-smooth``: t
Smooth (pixel) scroll *(snapped to line on completion).*
``scroll-on-drag-clamp``: nil
Prevent scrolling past the end of the buffer.
``scroll-on-drag-delay``: 0.01, typically in range [0.005 .. 0.1]
- Time between scroll updates.
+ Time between scroll updates (in seconds).
``scroll-on-drag-motion-scale``: 0.25, typically in range [0.01 .. 1.0]
Scale cursor motion, to make scrolling easier to control.
``scroll-on-drag-motion-accelerate``: 0.3, typically in range [0.0 .. 1.0]
diff --git a/scroll-on-drag.el b/scroll-on-drag.el
index 12cf87f2be..6c00c67864 100644
--- a/scroll-on-drag.el
+++ b/scroll-on-drag.el
@@ -26,7 +26,7 @@
(defgroup scroll-on-drag nil "Configure smooth scrolling on drag." :group
'scrolling)
(defcustom scroll-on-drag-style 'line-by-pixel
- "The method of scrolling."
+ "The the method scrolling is calculated."
:type '(choice (const :tag "Line" line) (const :tag "Line-By-Pixel"
line-by-pixel)))
(defcustom scroll-on-drag-delay 0.01 "Idle time between scroll updates (in
seconds)." :type 'float)
