docs(Functions): clarify type annotation restrictions when using function_handle (#2639)

Author: jonasblanc

cognite/client/_api/functions/__init__.py

@@ -245,6 +245,11 @@ async def create(
             .. note:
                 When using a predefined function object, you can list dependencies between the tags `[requirements]` and `[/requirements]` in the function's docstring.
                 The dependencies will be parsed and validated in accordance with requirement format specified in `PEP 508 <https://peps.python.org/pep-0508/>`_.
+
+            .. note:
+                Only the source code of the handle function itself is deployed. Non-builtin type
+                annotations (e.g. ``client: CogniteClient``) will cause a ``NameError`` at deploy
+                time. Either omit the annotation or use string form (e.g. ``client: "CogniteClient"``).
         """
         if isinstance(name, FunctionWrite):
             function_input = name

cognite/client/_sync_api/functions/__init__.py

@@ -1,6 +1,6 @@
 """
 ===============================================================================
-9a58504453f212b9189304aa9ac90385
+cae4f37f697c159b6c87429edc9005ee
 This file is auto-generated from the Async API modules, - do not edit manually!
 ===============================================================================
 """
@@ -214,6 +214,11 @@ def create(
             .. note:
                 When using a predefined function object, you can list dependencies between the tags `[requirements]` and `[/requirements]` in the function's docstring.
                 The dependencies will be parsed and validated in accordance with requirement format specified in `PEP 508 <https://peps.python.org/pep-0508/>`_.
+
+            .. note:
+                Only the source code of the handle function itself is deployed. Non-builtin type
+                annotations (e.g. ``client: CogniteClient``) will cause a ``NameError`` at deploy
+                time. Either omit the annotation or use string form (e.g. ``client: "CogniteClient"``).
         """
         return run_sync(
             self.__async_client.functions.create(

cognite/client/data_classes/functions.py

@@ -48,12 +48,17 @@ class FunctionHandle(Protocol):
         .. code-block:: python
 
             def handle(
-                client: CogniteClient | None = None,
+                client: "CogniteClient",
                 data: dict[str, object] | None = None,
             ) -> object:
                 # Do something with the data
                 return {"result": "success"}
 
+    Note:
+        Only the source code of the handle function itself is deployed. Non-builtin type
+        annotations (e.g. ``CogniteClient``) will cause a ``NameError`` at deploy time.
+        Either omit the annotation or use string form (e.g. ``client: "CogniteClient"``).
+
     Returns:
         object: Return value of the function. Any JSON serializable object is allowed.
     """