Skip to content

Commit 34c4d9a

Browse files
Add docs to viewspec dataclass.
1 parent 3c5acf7 commit 34c4d9a

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

matplotview/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@ def inset_zoom_axes(
111111
112112
filter_set: Iterable[Union[Type[Artist], Artist]] or None
113113
An optional filter set, which can be used to select what artists
114-
are drawn by the view. Any artists types in the set are not drawn.
114+
are drawn by the view. Any artists or artist types in the set are not
115+
drawn.
115116
116117
scale_lines: bool, defaults to True
117118
Specifies if lines should be drawn thicker based on scaling in the

matplotview/_view_axes.py

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,29 @@ def _view_from_pickle(builder, args):
9898

9999
@dataclass
100100
class ViewSpecification:
101+
"""
102+
A view specification, or a mutable dataclass containing configuration
103+
options for a view's "viewing" of a different axes.
104+
105+
Parameters:
106+
-----------
107+
image_interpolation: string
108+
Supported options are 'antialiased', 'nearest', 'bilinear',
109+
'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite',
110+
'kaiser', 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell',
111+
'sinc', 'lanczos', or 'none'. The default value is 'nearest'. This
112+
determines the interpolation used when attempting to render a
113+
zoomed version of an image.
114+
115+
filter_set: Iterable[Union[Type[Artist], Artist]] or None
116+
An optional filter set, which can be used to select what artists
117+
are drawn by the view. Any artists or artist types in the set are not
118+
drawn.
119+
120+
scale_lines: bool, defaults to True
121+
Specifies if lines should be drawn thicker based on scaling in the
122+
view.
123+
"""
101124
image_interpolation: str = "nearest"
102125
filter_set: Optional[Set[Union[Type[Artist], Artist]]] = None
103126
scale_lines: bool = True

0 commit comments

Comments
 (0)