aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsigoden <sigoden@gmail.com>2024-08-03 03:14:29 +0000
committersigoden <sigoden@gmail.com>2024-08-03 03:16:29 +0000
commit766ec231f598276b1c792c759986f431ed2b43a9 (patch)
treed86ff63569bf08e2275ddeb088c9c39f80a92317
parent556713a18ce738785ac9188db7089dd70a326c12 (diff)
downloadllm-functions-docker-766ec231f598276b1c792c759986f431ed2b43a9.tar.gz
chore: update description of some tools
-rw-r--r--README.md8
-rwxr-xr-xtools/execute_command.sh2
-rw-r--r--tools/execute_js_code.js2
-rw-r--r--tools/execute_py_code.py2
4 files changed, 7 insertions, 7 deletions
diff --git a/README.md b/README.md
index c8c26af..304faf3 100644
--- a/README.md
+++ b/README.md
@@ -70,7 +70,7 @@ Create a new bashscript in the [./tools/](./tools/) directory (.e.g. `execute_co
#!/usr/bin/env bash
set -e
-# @describe Runs a shell command.
+# @describe Execute the shell command.
# @option --command! The command to execute.
main() {
@@ -86,7 +86,7 @@ Create a new javascript in the [./tools/](./tools/) directory (.e.g. `execute_js
```js
/**
- * Runs the javascript code in node.js.
+ * Execute the javascript code in node.js.
* @typedef {Object} Args
* @property {string} code - Javascript code to execute, such as `console.log("hello world")`
* @param {Args} args
@@ -99,11 +99,11 @@ exports.main = function main({ code }) {
### Python
-Create a new python script in the [./tools/](./tools/) directory (e.g., `execute_py_code.py`).
+Create a new python script in the [./tools/](./tools/) directory (e.g. `execute_py_code.py`).
```py
def main(code: str):
- """Runs the python code.
+ """Execute the python code.
Args:
code: Python code to execute, such as `print("hello world")`
"""
diff --git a/tools/execute_command.sh b/tools/execute_command.sh
index 0e04b85..c9f4a7d 100755
--- a/tools/execute_command.sh
+++ b/tools/execute_command.sh
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
set -e
-# @describe Runs the shell command.
+# @describe Execute the shell command.
# @option --command! The command to execute.
main() {
diff --git a/tools/execute_js_code.js b/tools/execute_js_code.js
index bef6454..853ccab 100644
--- a/tools/execute_js_code.js
+++ b/tools/execute_js_code.js
@@ -1,5 +1,5 @@
/**
- * Runs the javascript code in node.js.
+ * Execute the javascript code in node.js.
* @typedef {Object} Args
* @property {string} code - Javascript code to execute, such as `console.log("hello world")`
* @param {Args} args
diff --git a/tools/execute_py_code.py b/tools/execute_py_code.py
index b4bf7b1..a774e82 100644
--- a/tools/execute_py_code.py
+++ b/tools/execute_py_code.py
@@ -1,5 +1,5 @@
def run(code: str):
- """Runs the python code.
+ """Execute the python code.
Args:
code: Python code to execute, such as `print("hello world")`
"""