Rooba
/
rich
mirror of https://github.com/Textualize/rich.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docstring for fit kwarg in RenderGroup and render_group

This commit is contained in:
Matthew Barber 2020-10-16 09:56:09 +01:00
parent 7e9cff8bed
commit c3f29f674c
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
rich/console.py
View File

@ -245,7 +245,7 @@ class RenderGroup:
Args:
renderables (Iterable[RenderableType]): An iterable of renderable objects.
fit (bool, optional): Use the longest constituent renderable as the group's minimum width if ``True``, otherwise expand the group to fit the availabe space. Defaults to True.
"""
def __init__(self, *renderables: "RenderableType", fit: bool = True) -> None:
@ -272,7 +272,11 @@ class RenderGroup:
def render_group(fit: bool = True) -> Callable:
"""A decorator that turns an iterable of renderables in to a group."""
"""A decorator that turns an iterable of renderables in to a group.
Args:
fit (bool, optional): Use the longest constituent renderable as the group's minimum width if ``True``, otherwise expand the group to fit the availabe space. Defaults to True.
"""
def decorator(method):
"""Convert a method that returns an iterable of renderables in to a RenderGroup."""