Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
@sbaldu
sbaldu committed May 2, 2024
1 parent 80f3f7e commit 461f315
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions CLUEstering/CLUEstering.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -773,6 +773,8 @@ def input_plotter(self, filepath: Union[str, None] = None, plot_title: str = '',
Parameters
----------
filepath : string, optional
The path to the file where the plot should be saved.
plot_title : string, optional
Title of the plot.
title_size : float, optional
Expand Down Expand Up @@ -921,30 +923,32 @@ def cluster_plotter(self, filepath: Union[str, None] = None, plot_title: str = '
Parameters
----------
filepath : string, optional
The path to the file where the plot should be saved.
plot_title : string, optional
Title of the plot
Title of the plot.
title_size : float, optional
Size of the plot title
Size of the plot title.
x_label : string, optional
Label on x-axis
Label on x-axis.
y_label : string, optional
Label on y-axis
Label on y-axis.
z_label : string, optional
Label on z-axis
Label on z-axis.
label_size : int, optional
Fontsize of the axis labels
Fontsize of the axis labels.
outl_size : int, optional
Size of the outliers in the plot
Size of the outliers in the plot.
pt_size : int, optional
Size of the points in the plot
Size of the points in the plot.
seed_size : int, optional
Size of the seeds in the plot
Size of the seeds in the plot.
grid : bool, optional
f true displays grids in the plot
f true displays grids in the plot.
grid_style : string, optional
Style of the grid
Style of the grid.
grid_size : float, optional
Linewidth of the plot grid
Linewidth of the plot grid.
x_ticks : list, optional
List of ticks for the x axis.
y_ticks : list, optional
Expand Down

0 comments on commit 461f315

Please sign in to comment.