Skip to content

Commit 371d615

Browse files
Modified docs (#295)
* modified sentence * modified quick-start.md
1 parent f871abc commit 371d615

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

src/introduction/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Introduction
22

3-
This section will guide you over a short introduction to CWL,
3+
This section will guide you through a short introduction to CWL,
44
the prerequisites for following this user guide, and some
5-
basic concepts that are useful before reading the rest of the
5+
basic concepts that are useful to know before reading the rest of the
66
user guide.
77

88
```{toctree}

src/introduction/quick-start.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Quick Start
22

3-
This section will show you a brief overview of what is CWL and where you
3+
This section will show you a brief overview of what CWL is, and where you
44
can learn more about it. No previous knowledge of CWL is required, but you
55
must be comfortable following instructions for the command-line.
66

@@ -20,20 +20,20 @@ with comments:
2020
```
2121

2222
The example above is just a wrapper for the `echo` command-line tool.
23-
Running the workflow above with the default input values, produces the
23+
Running the workflow above with the default input values will produce the same result as the
2424
command-line `echo "Hello World"`.
2525

2626
```{note}
27-
There is a distinction in CWL between a command-line tool and a workflow. But
28-
for the sake of simplicity we are using the term “workflow” here. You will learn
27+
In CWL, there is a distinction between a command-line tool and a workflow. But
28+
for the sake of simplicity, we are using the term “workflow” here. You will learn
2929
more about this in the [basic concepts](basic-concepts.md) section.
3030
```
3131

3232
## Installing a CWL runner
3333

3434
`cwltool` is an implementation of the CWL specification. It is also the
35-
CWL *Reference Runner* for the specification, and compliant with the
36-
latest version of the specification, {{ cwl_version }}. You can install
35+
CWL *Reference Runner* for the specification, and it is compliant with the
36+
latest version of the specification: {{ cwl_version }}. You can install
3737
`cwltool` using `pip`:
3838

3939
```{code-block} console
@@ -68,8 +68,8 @@ to how you would change the argument of the `echo` base command:
6868
```
6969

7070
Another way of passing values to your workflow input parameters is via an
71-
*Inputs Object*. This is a file containing the input fields with the
72-
corresponding values. This file can be written in JSON or YAML. For example:
71+
*Inputs Object*. This is a file containing the input fields with their
72+
corresponding values. The Inputs Objects file can be written in JSON or YAML. For example:
7373

7474
```{literalinclude} /_includes/cwl/hello_world-job.json
7575
:language: json
@@ -85,9 +85,9 @@ You can use this Inputs Object file now to execute the “Hello World” workflo
8585
```
8686

8787
```{note}
88-
We used a similar file name for the workflow and for the inputs object files.
88+
We used a similar file name for the workflow and for the Inputs Object files.
8989
The *-job.json* suffix is very common in Inputs Object files, but it is not
90-
a requirement. You can choose any name for your workflows and inputs object
90+
a requirement. You can choose any name for your workflows and Inputs Object
9191
files.
9292
```
9393

0 commit comments

Comments
 (0)