File tree Expand file tree Collapse file tree 2 files changed +12
-5
lines changed Expand file tree Collapse file tree 2 files changed +12
-5
lines changed Original file line number Diff line number Diff line change @@ -27,3 +27,6 @@ format:
27
27
lint :
28
28
black --check .
29
29
flake8 .
30
+
31
+ doc :
32
+ sphinx-build -M html doc/ build/
Original file line number Diff line number Diff line change 7
7
STEP_DRAW_STYLES = ["steps-pre" , "steps-post" , "steps-mid" ]
8
8
9
9
10
- def clean_figure (fig = None , target_resolution = 600 , scale_precision = 1.0 ):
10
+ def clean_figure (fig = None , target_resolution : int = 600 , scale_precision : float = 1.0 ):
11
11
"""Cleans figure as a preparation for tikz export.
12
12
This will minimize the number of points required for the tikz figure.
13
13
If the figure has subplots, it will recursively clean then up.
14
14
15
15
Note that this function modifies the figure directly (impure function).
16
16
17
17
:param fig: Matplotlib figure handle (Default value = None)
18
+
18
19
:param target_resolution: target resolution of final figure in PPI.
19
- If a scalar integer is provided, it is assumed to be square in both axis.
20
- If a list or an np.array is provided, it is interpreted as [H, W].
21
- By default 600
20
+ If a scalar integer is provided, it is assumed to be
21
+ square in both axis. If a list or an np.array is
22
+ provided, it is interpreted as [H, W].
23
+ By default 600
22
24
:type target_resolution: int, list or np.array, optional
25
+
23
26
:param scalePrecision: scalar value indicating precision when scaling down.
24
- By default 1
27
+ By default 1
25
28
:type scalePrecision: float, optional
29
+
26
30
Examples
27
31
--------
28
32
You can’t perform that action at this time.
0 commit comments