update show_plot descripiton in parameters

OpenMS · Jan 8, 2025 · d7dae4c · d7dae4c
1 parent 7f1210e
commit d7dae4c
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 8 deletions.
diff --git a/docs/Parameters/basePlot.tsv b/docs/Parameters/basePlot.tsv
@@ -12,4 +12,4 @@ toolbar_location	“above”		Location of toolbar for interactive plots. One of:
 fig	None	fig	Existing Figure object to plot on
 xlabel	None	str	Label for x axis
 ylabel 	None	str	Label for y axis
-show_plot	True	bool	Whether to display the plot
+show_plot	True	bool	Whether to display the plot. If plot is not shown, will return the plot object corresponding with the backend. If plot is displayed the method returns None
diff --git a/docs/Parameters/chromatogramPlot.tsv b/docs/Parameters/chromatogramPlot.tsv
@@ -12,4 +12,4 @@ toolbar_location	“above”		Location of toolbar for interactive plots. One of:
 fig	None	fig	Existing figure object to plot on. Useful for matplotlib backend 
 xlabel	None	str	Label for x axis
 ylabel 	None	str	Label for y axis
-show_plot	True	bool	Whether to display the plot
+show_plot	True	bool	Whether to display the plot. If plot is not shown, will return the plot object corresponding with the backend. If plot is displayed the method returns None
diff --git a/docs/Parameters/mobilogramPlot.tsv b/docs/Parameters/mobilogramPlot.tsv
@@ -12,4 +12,4 @@ toolbar_location	“above”		Location of toolbar for interactive plots. One of:
 fig	None	fig	Existing figure object to plot on. Useful for matplotlib backend 
 xlabel	None	str	Label for x axis
 ylabel 	None	str	Label for y axis
-show_plot	True	bool	Whether to display the plot
+show_plot	True	bool	Whether to display the plot. If plot is not shown, will return the plot object corresponding with the backend. If plot is displayed the method returns None
diff --git a/docs/Parameters/peakMapPlot.tsv b/docs/Parameters/peakMapPlot.tsv
@@ -14,10 +14,10 @@ fig	None	fig	Existing Figure object to plot on. Useful for matplotlib backend wh
 xlabel	“”	str	Label for x axis
 ylabel 	“”	str	Label for y axis
 zlabel	'’	str	Label for z-axis
-show_plot	True	bool	Whether to display the plot
-bin_peaks			
+show_plot	True	bool	Whether to display the plot. If plot is not shown, will return the plot object corresponding with the backend. If plot is displayed the method returns None
+bin_peaks	False	bool | “auto”	If True, will bin peaks based on specified number of bins in `num_x_bins`. If "auto", will automatically determine the number of bins based on the data using the strategy specified in `bin_method`. 
 aggregation_method	“mean”	Literal[“mean”, “sum”, “max”]	How to aggregate duplicate entries
 num_x_bins	50	int	Number of x-bins in heatmap
 num_y_bins	50	int	Number of y-bins in heatmap
-z_log_scale	False		
-fill_by_z	True	bool	
+z_log_scale	False	bool	Whether to log-transform z-axis
+fill_by_z	True	bool	Whether heatmap coloring should be based on z-axis values
diff --git a/docs/Parameters/spectrumPlot.tsv b/docs/Parameters/spectrumPlot.tsv
@@ -13,7 +13,7 @@ toolbar_location	“above”		Location of toolbar for interactive plots. One of:
 fig	None	fig	Existing Figure object to plot on
 xlabel	None	str	Label for x axis
 ylabel 	None	str	Label for y axis
-show_plot	True	bool	Whether to display the plot
+show_plot	True	bool	Whether to display the plot. If plot is not shown, will return the plot object corresponding with the backend. If plot is displayed the method returns None
 bin_peaks	False	bool | “auto”	If True, will bin peaks based on specified number of bins in `num_x_bins`. If "auto", will automatically determine the number of bins based on the data using the strategy specified in `bin_method`. 
 bin_method		“mz-tol-bin”	Binning method, one of [ “none”, “sturges”, “freedman-diaconis”, “mz-tol-bin”]
 num_x_bins	50	int	Number of bins, will be adjusted if bin_peaks is “auto”