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

docstrings

This commit is contained in:
Will McGugan 2020-10-09 15:22:26 +01:00
parent 914478eab4
commit 73738c7c74
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
rich/box.py
View File

@ -20,7 +20,9 @@ class Box:
│ ││ foot
└─┴┘ bottom
Args:
box (str): Characters making up box.
ascii (bool, optional): True if this box uses ascii characters only. Default is False.
"""
def __init__(self, box: str, *, ascii: bool = False) -> None:
@ -69,10 +71,10 @@ class Box:
Args:
options (ConsoleOptions): Console options used in rendering.
safe (bool, optional): Substitute this for another Box if there are known problems
in displaying (currently only relevant on Windows). Default is True.
displaying on the platform (currently only relevant on Windows). Default is True.
Returns:
[Box]: A different Box or the same Box.
Box: A different Box or the same Box.
"""
box = self
if options.legacy_windows and safe: