add note to ifm3dpy.run function

ifm · Mar 27, 2023 · 44f5083 · 44f5083
1 parent 6baa9b2
commit 44f5083
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/modules/pybind11/src/main.cpp b/modules/pybind11/src/main.cpp
@@ -81,6 +81,12 @@ PYBIND11_MODULE(ifm3dpy, m)
     R"(
         This function provides python application interface to run command line tool
 
+        Note: It is not recommended to use this for scripting as there is no way to 
+        monitor progress or handle errors, instead please directly use the functions 
+        provided by the corresponding modules. 
+        This function is mainly intended to be used to integrate the ifm3d CLI into 
+        existing console based applications.
+
         Parameters
         ----------
         argv : py::list