@@ -234,18 +234,27 @@ def __init__(self, aux_trans,
234
234
tick_formatter1 = None ,
235
235
tick_formatter2 = None ):
236
236
"""
237
- aux_trans : a transform from the source (curved) coordinate to
238
- target (rectilinear) coordinate. An instance of MPL's Transform
239
- (inverse transform should be defined) or a tuple of two callable
240
- objects which defines the transform and its inverse. The callables
241
- need take two arguments of array of source coordinates and
242
- should return two target coordinates.
243
-
244
- e.g., ``x2, y2 = trans(x1, y1)``
237
+ Parameters
238
+ ----------
239
+ aux_trans : `.Transform` or tuple[Callable, Callable]
240
+ The transform from curved coordinates to rectilinear coordinate:
241
+ either a `.Transform` instance (which provides also its inverse),
242
+ or a pair of callables ``(trans, inv_trans)`` that define the
243
+ transform and its inverse. The callables should have signature::
244
+
245
+ x_rect, y_rect = trans(x_curved, y_curved)
246
+ x_curved, y_curved = inv_trans(x_rect, y_rect)
247
+
248
+ extreme_finder
249
+
250
+ grid_locator1, grid_locator2
251
+ Grid locators for each axis.
252
+
253
+ tick_formatter1, tick_formatter2
254
+ Tick formatters for each axis.
245
255
"""
246
256
super ().__init__ ()
247
257
self ._grid_info = None
248
- self ._aux_trans = aux_trans
249
258
self .grid_finder = GridFinder (aux_trans ,
250
259
extreme_finder ,
251
260
grid_locator1 ,
0 commit comments