Skip to content

Commit

Permalink
minor fixes to plts docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
TomDonoghue committed Oct 1, 2024
1 parent fea05ad commit a5f2f1f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion lisc/plts/counts.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def plot_matrix(data, x_labels=None, y_labels=None, attribute='score', transpose
cmap : {'purple', 'blue'} or matplotlib.cmap
Colormap to use for the plot.
If string, uses a sequential palette of the specified color.
square : bool
square : bool, optional, default: False
Whether to plot all the cells as equally sized squares.
ax : matplotlib.Axes, optional
Figure axes upon which to plot.
Expand Down
8 changes: 4 additions & 4 deletions lisc/plts/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def check_aliases(kwargs, aliases, default=None):
Dictionary to check for elements labelled with possible aliases.
aliases : list
List of possible key value labels.
default
default : object or None, optional
Default value to return if none of the potential labels are present.
Returns
Expand Down Expand Up @@ -135,7 +135,7 @@ def check_ax(ax, figsize=None):
----------
ax : matplotlib.Axes or None
Axes object to check if is defined.
figsize : (float, float)
figsize : (float, float), optional
The figure size for a new axis, if ax is not defined.
Returns
Expand Down Expand Up @@ -189,7 +189,7 @@ def save_figure(file_name, file_path=None, close=False, **save_kwargs):
----------
file_name : str
File name for the figure file to save out.
file_path : str or Path
file_path : str or Path, optional
Path for where to save out the figure to.
close : bool, optional, default: False
Whether to close the plot after saving.
Expand All @@ -211,7 +211,7 @@ def rotate_ticks(ax, xtickrotation=None, ytickrotation=None):
----------
ax : matplotlib.Axes
Figure axes to apply tick rotation to.
xtickrotation, ytickrotation : float
xtickrotation, ytickrotation : float, optional
Rotation to apply to the x and/or y axis tick labels.
"""

Expand Down

0 comments on commit a5f2f1f

Please sign in to comment.