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_relative

Browse Source 
Delivering on a promise made in #1920.
This commit is contained in:
Dave Pearson
2023-03-01 14:22:34 +00:00
parent 21e7cfb9ca
commit 22b0b5b047
1 changed files with 8 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/textual/widget.py
View File

@@ -1511,17 +1511,16 @@ class Widget(DOMNode):
"""Scroll relative to current position.
Args:
x: X distance (columns) to scroll, or ``None`` for no change. Defaults to None.
y: Y distance (rows) to scroll, or ``None`` for no change. Defaults to None.
animate: Animate to new scroll position. Defaults to False.
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`.
x: X distance (columns) to scroll, or ``None`` for no change.
y: Y distance (rows) to scroll, or ``None`` for no change.
animate: Animate to new scroll position.
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 the scroll position changed, otherwise False.
`True` if the scroll position changed, otherwise `False`.
"""
return self.scroll_to(
None if x is None else (self.scroll_x + x),