Tidy up the docstring of Widget.scroll_up

Delivering on a promise made in #1920.
This commit is contained in:
Dave Pearson
2023-03-01 14:45:47 +00:00
parent f8167ac35e
commit ca1abcff5c

View File

@@ -1831,12 +1831,11 @@ class Widget(DOMNode):
"""Scroll one line up.
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.
"""
self.scroll_to(
y=self.scroll_target_y - 1,