From 73738c7c742ad520d518f968fa669c0d64b52267 Mon Sep 17 00:00:00 2001 From: Will McGugan Date: Fri, 9 Oct 2020 15:22:26 +0100 Subject: [PATCH] docstrings --- rich/box.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/rich/box.py b/rich/box.py index a1564dbd..a6d9f315 100644 --- a/rich/box.py +++ b/rich/box.py @@ -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: