docstring

This commit is contained in:
Will McGugan 2020-10-08 18:24:40 +01:00
parent ddd3aa3fe3
commit 077d57e73d
1 changed files with 2 additions and 1 deletions

View File

@ -67,8 +67,9 @@ class Box:
"""Substitute this box for another if it won't render due to platform issues.
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).
in displaying (currently only relevant on Windows). Default is True.
Returns:
[Box]: A different Box or the same Box.