Skip to content

Commit 63c7110

Browse files
Punctuation, grammar, and clarity.
Minor language fixes. My favorite is removing all of the redundant "the framework"s. DRY. :-D
1 parent 1416e3a commit 63c7110

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

doc/intro-to-core.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ done or not.
77

88
For some types of scripts (for example very short ones, or
99
non-destructive, fast executing scripts), it is not worth the effort.
10-
The problem is that often it is not until later that the benefit are
10+
The problem is that often it is not until later that the benefits are
1111
understood for a particular script. And then the programmer ends up
1212
wishing that the enhancements had been included in the script from the
1313
beginning.
@@ -19,15 +19,14 @@ For example, consider this 4 line script (pseudo code):
1919
make
2020
make install
2121

22-
There are many ways to do add the two enhancements to this code. This
22+
There are many ways to add the two enhancements to this code. This
2323
could be done directly with well-placed conditional statements, but
2424
such an over-simplified solution would limit the benefits. A better
2525
solution might be to use a special framework that can maximize the
2626
benefits of the enhancements (e.g. dependency analysis, logging,
27-
progress updates, debugging tools, etc.) Unfortunately, using such a
28-
framework requires more upfront effort to understand the
29-
framework(s), choose the framework, install the frameworks, and adapt
30-
the script to the framework. With either solution, there are real
27+
progress updates, debugging tools, etc.). Unfortunately, using such a
28+
framework requires more upfront effort to understand, choose, install, and adapt
29+
the script to the framework(s). With either solution, there are real
3130
risks that discourage adding the enhancements in the first place.
3231

3332
The goal of bashsteps is to address these risks. It is designed to be
@@ -66,7 +65,7 @@ direct. The key design choice here is that the code can appear in the
6665
same order as the unenhanced script, as opposed to being split out
6766
into separate functions or separate files. Another related point is
6867
that this design makes it easy to later split steps into multiple
69-
steps, and vise versa.
68+
steps, or to recombine multiple steps into fewer steps.
7069

7170
Now that we have created a couple steps, the lines that can test
7271
whether the step has been done can be inserted:
@@ -88,7 +87,7 @@ whether the step has been done can be inserted:
8887

8988
Now the script has been enhanced by both splitting it into steps and
9089
by including code that can test whether the step has been done. With
91-
The above minimal framework, however, the functionality of the script
90+
the above minimal framework, however, the functionality of the script
9291
is still unchanged.
9392

9493
To start getting benefits, here is a still-quite-simple framework

0 commit comments

Comments
 (0)