chore: update description of some tools

This commit is contained in:
sigoden
2024-08-03 03:14:29 +00:00
parent 556713a18c
commit 766ec231f5
4 changed files with 7 additions and 7 deletions
+4 -4
View File
@@ -70,7 +70,7 @@ Create a new bashscript in the [./tools/](./tools/) directory (.e.g. `execute_co
#!/usr/bin/env bash #!/usr/bin/env bash
set -e set -e
# @describe Runs a shell command. # @describe Execute the shell command.
# @option --command! The command to execute. # @option --command! The command to execute.
main() { main() {
@@ -86,7 +86,7 @@ Create a new javascript in the [./tools/](./tools/) directory (.e.g. `execute_js
```js ```js
/** /**
* Runs the javascript code in node.js. * Execute the javascript code in node.js.
* @typedef {Object} Args * @typedef {Object} Args
* @property {string} code - Javascript code to execute, such as `console.log("hello world")` * @property {string} code - Javascript code to execute, such as `console.log("hello world")`
* @param {Args} args * @param {Args} args
@@ -99,11 +99,11 @@ exports.main = function main({ code }) {
### Python ### 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 ```py
def main(code: str): def main(code: str):
"""Runs the python code. """Execute the python code.
Args: Args:
code: Python code to execute, such as `print("hello world")` code: Python code to execute, such as `print("hello world")`
""" """
+1 -1
View File
@@ -1,7 +1,7 @@
#!/usr/bin/env bash #!/usr/bin/env bash
set -e set -e
# @describe Runs the shell command. # @describe Execute the shell command.
# @option --command! The command to execute. # @option --command! The command to execute.
main() { main() {
+1 -1
View File
@@ -1,5 +1,5 @@
/** /**
* Runs the javascript code in node.js. * Execute the javascript code in node.js.
* @typedef {Object} Args * @typedef {Object} Args
* @property {string} code - Javascript code to execute, such as `console.log("hello world")` * @property {string} code - Javascript code to execute, such as `console.log("hello world")`
* @param {Args} args * @param {Args} args
+1 -1
View File
@@ -1,5 +1,5 @@
def run(code: str): def run(code: str):
"""Runs the python code. """Execute the python code.
Args: Args:
code: Python code to execute, such as `print("hello world")` code: Python code to execute, such as `print("hello world")`
""" """