alihan/textual
1
0
Fork 0
mirror of https://github.com/Textualize/textual.git synced 2025-10-17 02:38:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

Tidy up the docstring of Widget._scroll_down_for_pointer

Browse Source 
Delivering on a promise made in #1920.
This commit is contained in:
Dave Pearson
2023-03-01 14:43:55 +00:00
parent 2deb90eb8d
commit 0992b3650d
1 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/textual/widget.py
View File

@@ -1797,12 +1797,11 @@ class Widget(DOMNode):
"""Scroll down one position, taking scroll sensitivity into account.
Args:
animate: Animate scroll. Defaults to True.
speed: Speed of scroll if animate is True. Or None to use duration.
duration: Duration of animation, if animate is True and speed is None.
easing: An easing method for the scrolling animation. Defaults to "None",
which will result in Textual choosing the configured default scrolling easing function.
force: Force scrolling even when prohibited by overflow styling. Defaults to `False`.
animate: Animate scroll.
speed: Speed of scroll if `animate` is `True`; or None to use duration.
duration: Duration of animation, if `animate` is `True` and `speed` is `None`.
easing: An easing method for the scrolling animation.
force: Force scrolling even when prohibited by overflow styling.
Returns:
True if any scrolling was done.