From bca51ca1640a93e5d9f7e50b03729e3075f2db36 Mon Sep 17 00:00:00 2001
From: Matt Hull <85494120+matt-hull0@users.noreply.github.com>
Date: Sun, 8 Sep 2024 19:48:24 +0100
Subject: [PATCH] docs: Update func doc strings in tools_human (#26149)

Thank you for contributing to LangChain!

- [x] **PR title**: "package: description"
- Where "package" is whichever of langchain, community, core,
experimental, etc. is being modified. Use "docs: ..." for purely docs
changes, "templates: ..." for template changes, "infra: ..." for CI
changes.
  - Example: "community: add foobar LLM"


- [x] **PR message**: ***Delete this entire checklist*** and replace
with
- **Description:** Fix docstring for two functions that look like have
docstrings carried over from other functions.
    - **Issue:** Not found issue reporting the miss-leading docstrings.
    - **Dependencies:** None
    - **Twitter handle:**


- [x] **Add tests and docs**: If you're adding a new integration, please
include
1. a test for the integration, preferably unit tests that do not rely on
network access,
2. an example notebook showing its use. It lives in
`docs/docs/integrations` directory.


- [x] **Lint and test**: Run `make format`, `make lint` and `make test`
from the root of the package(s) you've modified. See contribution
guidelines for more: https://python.langchain.com/docs/contributing/

Additional guidelines:
- Make sure optional dependencies are imported within a function.
- Please do not add dependencies to pyproject.toml files (even optional
ones) unless they are required for unit tests.
- Most PRs should not touch more than one package.
- Changes should be backwards compatible.
- If you are adding something to community, do not re-import it in
langchain.

If no one reviews your PR within a few days, please @-mention one of
baskaryan, efriis, eyurtsev, ccurme, vbarda, hwchase17.

---------

Co-authored-by: Erick Friis <erick@langchain.dev>
---
 docs/docs/how_to/tools_human.ipynb | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/docs/how_to/tools_human.ipynb b/docs/docs/how_to/tools_human.ipynb
index c5bcbf3c01a68..5e5312debde9b 100644
--- a/docs/docs/how_to/tools_human.ipynb
+++ b/docs/docs/how_to/tools_human.ipynb
@@ -129,13 +129,13 @@
     "\n",
     "@tool\n",
     "def count_emails(last_n_days: int) -> int:\n",
-    "    \"\"\"Multiply two integers together.\"\"\"\n",
+    "    \"\"\"Dummy function to count number of e-mails. Returns 2 * last_n_days.\"\"\"\n",
     "    return last_n_days * 2\n",
     "\n",
     "\n",
     "@tool\n",
     "def send_email(message: str, recipient: str) -> str:\n",
-    "    \"Add two integers.\"\n",
+    "    \"\"\"Dummy function for sending an e-mail.\"\"\"\n",
     "    return f\"Successfully sent email to {recipient}.\"\n",
     "\n",
     "\n",