From 44f5083596e1102308fc077185deeec9d1e53d91 Mon Sep 17 00:00:00 2001
From: Marco Kirchner <marco.kirchner@ifm.com>
Date: Mon, 27 Mar 2023 10:44:40 +0200
Subject: [PATCH] add note to ifm3dpy.run function

---
 modules/pybind11/src/main.cpp | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/modules/pybind11/src/main.cpp b/modules/pybind11/src/main.cpp
index 4ac3ab52..53e47bb5 100644
--- 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