Skip to content

Commit

Permalink
Tidy up the docstring of Widget.scroll_home
Browse files Browse the repository at this point in the history
Delivering on a promise made in Textualize#1920.
  • Loading branch information
davep committed Mar 1, 2023
1 parent 22b0b5b commit 48dd54c
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions src/textual/widget.py
Original file line number Diff line number Diff line change
Expand Up @@ -1544,12 +1544,11 @@ def scroll_home(
"""Scroll to home position.
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.
Expand Down

0 comments on commit 48dd54c

Please sign in to comment.