Skip to content

Commit ba214ce

Browse files
committed
More type hints and formatting.
1 parent 5be3a91 commit ba214ce

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

pgfutils.py

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -653,7 +653,12 @@ def _list_opened_files():
653653

654654

655655
def setup_figure(
656-
width=1.0, height=1.0, columns=None, margin=False, full_width=False, **kwargs
656+
width: float | str = 1.0,
657+
height: float | str = 1.0,
658+
columns: int | None = None,
659+
margin: bool = False,
660+
full_width: bool = False,
661+
**kwargs,
657662
):
658663
"""Set up matplotlib figures for PGF output.
659664
@@ -663,21 +668,20 @@ def setup_figure(
663668
664669
Parameters
665670
----------
666-
width, height : float or string
671+
width, height
667672
If a float, the fraction of the corresponding text width or height that the
668673
figure should take up. If a string, a dimension in centimetres (cm), millimetres
669674
(mm), inches (in) or points (pt). For example, '3in' or '2.5 cm'.
670-
columns : integer, optional
675+
columns
671676
The number of columns the figure should span. This should be between 1 and the
672677
total number of columns in the document (as specified in the configuration). A
673-
value of None corresponds to spanning all columns. Any other value results in a
674-
ValueError being raised.
675-
margin : Boolean, default False
678+
value of None corresponds to spanning all columns.
679+
margin
676680
If True, a margin figure (i.e., one to fit within the margin notes in the
677681
document) is generated. If the width is a fraction, it is treated as a fraction
678682
of the marginpar_width configuration setting. The height is still treated as a
679683
fraction of the text height. The columns setting is ignored if this is True.
680-
full_width : Boolean, default False
684+
full_width
681685
If True, a full-width figure, i.e., one spanning the main text, the margin
682686
notes, and the separator between them, is generated. A fractional width is
683687
treated relative to the full width. The height is still treated as a fraction of

0 commit comments

Comments
 (0)