Skip to content

Commit 549a544

Browse files
committed
clarify internal-run/README
1 parent 4a1b2b9 commit 549a544

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

examples/internal-run/README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Internal Run Example
22

3-
This example demonstrates how to utilize the internal `run` function in order
4-
to call other commands internally, using the same syntax as would be used by
5-
a user in the CLI.
3+
This example demonstrates how to use the `run` function to call commands
4+
internally, using the exact same syntax as a user would in the CLI. This
5+
approach can be useful for chaining commands or reusing logic without
6+
duplicating code.
67

78
This example was generated with:
89

@@ -14,6 +15,15 @@ $ bashly generate
1415
$ bashly generate
1516
```
1617

18+
Note that while this pattern of calling `run` internally is supported, you may
19+
want to consider using [lib functions]
20+
instead, for a more robust codebase.
21+
22+
While this pattern of calling run internally is supported, you may want to
23+
consider using [lib functions](https://bashly.dannyb.co/usage/writing-your-scripts/#adding-common-functions)
24+
instead. lib functions can help create a more robust and maintainable codebase
25+
by centralizing reusable logic.
26+
1727
<!-- include: src/build_command.sh -->
1828
<!-- include: src/test_command.sh -->
1929
<!-- include: src/deploy_command.sh -->

0 commit comments

Comments
 (0)