Skip to content

Commit

Permalink
DOC: Improve plot_corrmat function docstring
Browse files Browse the repository at this point in the history
Improve `plot_corrmat` function docstring:
- Match the order of parameters in the function signature.
- Document the `symmetric` and `figsize` parameters.
  • Loading branch information
jhlegarreta committed Oct 29, 2024
1 parent 3ede9e9 commit e28b853
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions mriqc_learn/viz/metrics.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,17 +193,22 @@ def plot_corrmat(
----------
data
A 2D numpy array of shape (M, N).
row_labels
A list or array of length M with the labels for the rows.
col_labels
A list or array of length N with the labels for the columns.
row_labels
A list or array of length M with the labels for the rows.
ax
A `matplotlib.axes.Axes` instance to which the heatmap is plotted. If
not provided, use current axes or create a new one. Optional.
cbar_kw
A dictionary with arguments to `matplotlib.Figure.colorbar`. Optional.
cbarlabel
The label for the colorbar. Optional.
symmetric
Use ``True`` if the matrix is symmetric to plot only the lower
triangular part of the matrix.
figsize
Figure size (width, height) in inches.
**kwargs
All other arguments are forwarded to `imshow`.
Expand Down

0 comments on commit e28b853

Please sign in to comment.