Skip to content

Commit 7833df0

Browse files
committed
Add docs for mesh layer_plot() and slice_plot() value label and unit
1 parent 52219da commit 7833df0

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

layermesh/mesh.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1279,6 +1279,8 @@ def layer_plot(self, lay = -1, **kwargs):
12791279
* *linewidth*: the line width of the mesh (default *0.2*).
12801280
* *value*: a tuple, list or array of values to plot over the mesh,
12811281
of length equal to the number of cells in the mesh.
1282+
* *value_label*: string label for plotted values.
1283+
* *value_unit*: string for units of plotted values.
12821284
* *xlabel*: label string for the plot *x*-axis (default *'x'*).
12831285
* *ylabel*: label string for the plot *y*-axis (default *'y'*).
12841286
@@ -1401,6 +1403,8 @@ def slice_plot(self, line = 'x', **kwargs):
14011403
* *linewidth*: the line width of the mesh (default *0.2*).
14021404
* *value*: a tuple, list or array of values to plot over the mesh,
14031405
of length equal to the number of cells in the mesh.
1406+
* *value_label*: string label for plotted values.
1407+
* *value_unit*: string for units of plotted values.
14041408
* *xlabel*: label string for the plot *x*-axis (default *'x'*).
14051409
* *ylabel*: label string for the plot *y*-axis (default *'z'*).
14061410

0 commit comments

Comments
 (0)