From 715bff2dcdff79296802c5ca90fd33d2ff4b45db Mon Sep 17 00:00:00 2001
From: Carl Philipp Klemm <philipp@uvos.xyz>
Date: Thu, 28 Mar 2024 13:56:52 +0100
Subject: [PATCH] improve documentation

---
 eisgenerator/model.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/eisgenerator/model.h b/eisgenerator/model.h
index e5f9dce..ef2cef0 100644
--- a/eisgenerator/model.h
+++ b/eisgenerator/model.h
@@ -292,6 +292,11 @@ public:
 	/**
 	* @brief Gets a set of indecies that together create a iso-difference set of spectra.
 	*
+	* Note: this function generates a signifcant fraction of the number of spectra in the models range
+	* use getRequiredStepsForSweeps for an estimate of the complexity. It is strongly recommended to call compile()
+	* before using this function.
+	*
+	* @param threaded if this is set to true eisgenerator will spawn nproc number of threads to service this request.
 	* @param distance the target distance between subisquent spectra relative to eis::eisDistance.
 	* @return A vector of indecies corresponding to the iso-difference spectras.
 	*/
-- 
GitLab