Skip to content

Commit

Permalink
chore: update description of some tools
Browse files Browse the repository at this point in the history
  • Loading branch information
sigoden committed Aug 3, 2024
1 parent 556713a commit 766ec23
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand All @@ -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
Expand All @@ -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")`
"""
Expand Down
2 changes: 1 addition & 1 deletion tools/execute_command.sh
Original file line number Diff line number Diff line change
@@ -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() {
Expand Down
2 changes: 1 addition & 1 deletion tools/execute_js_code.js
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion tools/execute_py_code.py
Original file line number Diff line number Diff line change
@@ -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")`
"""
Expand Down

0 comments on commit 766ec23

Please sign in to comment.