fixes #61

Author: jph00

01_funccall.ipynb

@@ -736,11 +736,11 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "23f54386",
+   "id": "748da965",
    "metadata": {},
    "outputs": [],
    "source": [
-    "#| exports\n",
+    "#| export\n",
     "def get_schema(\n",
     "    f:Union[callable,dict], # Function to get schema for\n",
     "    pname='input_schema',   # Key name for parameters\n",
@@ -754,7 +754,12 @@
     "    assert desc, \"Docstring missing!\"\n",
     "    d = docments(f, full=True)\n",
     "    ret = d.pop('return')\n",
-    "    if (ret.anno is not empty) and (ret.anno is not None): desc += f'\\n\\nReturns:\\n- type: {_types(ret.anno)[0]}'\n",
+    "    has_type = (ret.anno is not empty) and (ret.anno is not None)\n",
+    "    has_doc = ret.docment\n",
+    "    if has_type or has_doc:\n",
+    "        type_str = f'type: {_types(ret.anno)[0]}'\n",
+    "        ret_str = f'{ret.docment} ({type_str})' if has_type and has_doc else (type_str if has_type else ret.docment)\n",
+    "        desc += f'\\n\\nReturns:\\n- {ret_str}'\n",
     "    return {\"name\": f.__name__, \"description\": desc, pname: schema}"
    ]
   },
@@ -768,7 +773,7 @@
      "data": {
       "text/plain": [
        "{'name': 'get_schema',\n",
-       " 'description': 'Generate JSON schema for a class, function, or method\\n\\nReturns:\\n- type: object',\n",
+       " 'description': \"Generate JSON schema for a class, function, or method\\n\\nReturns:\\n- {'name':..., 'description':..., pname:...} (type: object)\",\n",
        " 'input_schema': {'type': 'object',\n",
        "  'properties': {'f': {'type': 'object',\n",
        "    'description': 'Function to get schema for',\n",
@@ -823,7 +828,7 @@
       "Adds a + b.\n",
       "\n",
       "Returns:\n",
-      "- type: integer\n"
+      "- The sum of the inputs (type: integer)\n"
      ]
     },
     {
@@ -872,7 +877,7 @@
      "data": {
       "text/plain": [
        "{'name': 'silly_test',\n",
-       " 'description': 'Mandatory docstring',\n",
+       " 'description': 'Mandatory docstring\\n\\nReturns:\\n- type: integer',\n",
        " 'input_schema': {'type': 'object',\n",
        "  'properties': {'a': {'type': 'integer', 'description': 'quoted type hint'}},\n",
        "  'required': ['a']}}"
@@ -886,7 +891,7 @@
    "source": [
     "def silly_test(\n",
     "    a: 'int',  # quoted type hint\n",
-    "):\n",
+    ")->int:\n",
     "    \"Mandatory docstring\"\n",
     "    return a\n",
     "\n",
@@ -911,7 +916,7 @@
      "data": {
       "text/plain": [
        "{'name': 'sums',\n",
-       " 'description': 'Adds a + b.\\n\\nReturns:\\n- type: integer',\n",
+       " 'description': 'Adds a + b.',\n",
        " 'input_schema': {'type': 'object',\n",
        "  'properties': {'a': {'type': 'integer', 'description': 'First thing to sum'},\n",
        "   'b': {'type': 'integer',\n",
@@ -931,7 +936,7 @@
     "        self,\n",
     "        a:int,  # First thing to sum\n",
     "        b:int=1 # Second thing to sum\n",
-    "    ) -> int: # The sum of the inputs\n",
+    "    ): # The sum of the inputs\n",
     "        \"Adds a + b.\"\n",
     "        print(f\"Finding the sum of {a} and {b}\")\n",
     "        return a + b\n",

toolslm/funccall.py

@@ -141,7 +141,12 @@ def get_schema(
     assert desc, "Docstring missing!"
     d = docments(f, full=True)
     ret = d.pop('return')
-    if (ret.anno is not empty) and (ret.anno is not None): desc += f'\n\nReturns:\n- type: {_types(ret.anno)[0]}'
+    has_type = (ret.anno is not empty) and (ret.anno is not None)
+    has_doc = ret.docment
+    if has_type or has_doc:
+        type_str = f'type: {_types(ret.anno)[0]}'
+        ret_str = f'{ret.docment} ({type_str})' if has_type and has_doc else (type_str if has_type else ret.docment)
+        desc += f'\n\nReturns:\n- {ret_str}'
     return {"name": f.__name__, "description": desc, pname: schema}
 
 # %% ../01_funccall.ipynb