Make example objects more granular

Author: kesmit13

singlestoredb/functions/ext/asgi.py

@@ -1262,14 +1262,26 @@ def get_function_info(
                         doc_summary = docs.short_description or ''
                         doc_long_description = docs.long_description or ''
                     for ex in docs.examples:
-                        out = []
+                        ex_dict: Dict[str, Any] = {
+                            'description': None,
+                            'code': None,
+                            'output': None,
+                        }
                         if ex.description:
-                            out.append(ex.description)
+                            ex_dict['description'] = ex.description
                         if ex.snippet:
-                            out.append(ex.snippet)
+                            code, output = [], []
+                            for line in ex.snippet.split('\n'):
+                                line = line.rstrip()
+                                if re.match(r'^(\w+>|>>>|\.\.\.)', line):
+                                    code.append(line)
+                                else:
+                                    output.append(line)
+                            ex_dict['code'] = '\n'.join(code) or None
+                            ex_dict['output'] = '\n'.join(output) or None
                         if ex.post_snippet:
-                            out.append(ex.post_snippet)
-                        doc_examples.append('\n'.join(out))
+                            ex_dict['postscript'] = ex.post_snippet
+                        doc_examples.append(ex_dict)
 
                 except Exception as e:
                     logger.warning(

singlestoredb/tests/ext_funcs/__init__.py

@@ -28,6 +28,43 @@
 from singlestoredb.functions.typing import pyarrow as pat
 
 
+@udf
+def doc_test(x: int, y: float) -> int:
+    """
+    A simple function to test the decorator and documentation.
+
+    Parameters
+    ----------
+    x : int
+        An integer to be multiplied by 2.
+    y : float
+        A float that is not used in the computation.
+
+    Examples
+    --------
+    Basic usage of the function:
+    >>> doc_test(3, 4.5)
+    6
+
+    Another example with different values:
+    >>> doc_test(5, 2.0)
+    10
+
+    SQL Example
+    sql> SELECT doc_test(3, 4.5);
+    6
+
+    Final text
+
+    Returns
+    -------
+    int
+        The input integer multiplied by 2.
+
+    """
+    return x * 2
+
+
 @udf
 def int_mult(x: int, y: int) -> int:
     return x * y