diff --git a/lisc/plts/counts.py b/lisc/plts/counts.py index ff020f4..019ed28 100644 --- a/lisc/plts/counts.py +++ b/lisc/plts/counts.py @@ -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. diff --git a/lisc/plts/utils.py b/lisc/plts/utils.py index 22f9376..e6f4d1f 100644 --- a/lisc/plts/utils.py +++ b/lisc/plts/utils.py @@ -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 @@ -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 @@ -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. @@ -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. """