Skip to content

Commit f916947

Browse files
fmigneaultmr-c
andauthored
fix typos spotted across docs (#205)
Co-authored-by: Michael R. Crusoe <[email protected]>
1 parent f0f9bc2 commit f916947

File tree

5 files changed

+34
-34
lines changed

5 files changed

+34
-34
lines changed

CommandLineTool.yml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ $graph:
104104
where these approaches are application or platform specific it creates a
105105
significant barrier to reproducibility and portability, as methods
106106
developed for one platform must be manually ported to be used on new
107-
platforms. Similarly it creates redundant work, as wrappers for popular
107+
platforms. Similarly, it creates redundant work, as wrappers for popular
108108
tools must be rewritten for each application or platform in use.
109109
110110
The Common Workflow Language Command Line Tool Description is designed to
@@ -143,7 +143,7 @@ $graph:
143143
doc: |
144144
145145
When listed under `inputBinding` in the input schema, the term
146-
"value" refers to the the corresponding value in the input object. For
146+
"value" refers to the corresponding value in the input object. For
147147
binding objects listed in `CommandLineTool.arguments`, the term "value"
148148
refers to the effective value after evaluating `valueFrom`.
149149
@@ -168,7 +168,7 @@ $graph:
168168
169169
- **array**: If `itemSeparator` is specified, add `prefix` and the join
170170
the array into a single string with `itemSeparator` separating the
171-
items. Otherwise first add `prefix`, then recursively process
171+
items. Otherwise, first add `prefix`, then recursively process
172172
individual elements.
173173
If the array is empty, it does not add anything to command line.
174174
@@ -203,7 +203,7 @@ $graph:
203203
type: string?
204204
doc: |
205205
Join the array elements into a single string with the elements
206-
separated by by `itemSeparator`.
206+
separated by `itemSeparator`.
207207
- name: valueFrom
208208
type:
209209
- "null"
@@ -310,7 +310,7 @@ $graph:
310310
element. The exit code of the process is
311311
available in the expression as `runtime.exitCode`.
312312
313-
Additionally if `loadContents` is true, the file must be a
313+
Additionally, if `loadContents` is true, the file must be a
314314
UTF-8 text file 64 KiB or smaller, and the implementation must
315315
read the entire contents of the file (or file array) and place
316316
it in the `contents` field of the File object for use in
@@ -457,7 +457,7 @@ $graph:
457457
- name: inputBinding
458458
type: CommandLineBinding?
459459
doc: |
460-
Describes how to turns the input parameters of a process into
460+
Describes how to turn the input parameters of a process into
461461
command line arguments.
462462
jsonldPredicate: "cwl:inputBinding"
463463

@@ -745,7 +745,7 @@ $graph:
745745
extends: ProcessRequirement
746746
doc: |
747747
Indicates that a workflow component should be run in a
748-
[Docker](http://docker.com) or Docker-compatible (such as
748+
[Docker](https://docker.com) or Docker-compatible (such as
749749
[Singularity](https://www.sylabs.io/) and [udocker](https://github.com/indigo-dc/udocker)) container environment and
750750
specifies how to fetch or build the image.
751751
@@ -815,7 +815,7 @@ $graph:
815815
`dockerPull: ubuntu@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2`
816816
- name: dockerLoad
817817
type: string?
818-
doc: "Specify a HTTP URL from which to download a Docker image using `docker load`."
818+
doc: "Specify an HTTP URL from which to download a Docker image using `docker load`."
819819
- name: dockerFile
820820
type: string?
821821
doc: "Supply the contents of a Dockerfile which will be built using `docker build`."
@@ -881,7 +881,7 @@ $graph:
881881
One or more [IRI](https://en.wikipedia.org/wiki/Internationalized_Resource_Identifier)s
882882
identifying resources for installing or enabling the software named in
883883
the `package` field. Implementations may provide resolvers which map
884-
these software identifer IRIs to some configuration action; or they can
884+
these software identifier IRIs to some configuration action; or they can
885885
use only the name from the `package` field on a best effort basis.
886886
887887
For example, the IRI https://packages.debian.org/bowtie could
@@ -893,15 +893,15 @@ $graph:
893893
software installation or selection mechanism.
894894
Using [RRID](https://www.identifiers.org/rrid/) as an example:
895895
https://identifiers.org/rrid/RRID:SCR_005476
896-
could be fulfilled using the above mentioned Debian or bioconda
897-
package, a local installation managed by [Environment Modules](http://modules.sourceforge.net/),
896+
could be fulfilled using the above-mentioned Debian or bioconda
897+
package, a local installation managed by [Environment Modules](https://modules.sourceforge.net/),
898898
or any other mechanism the platform chooses. IRIs can also be from
899-
identifer sources that are discipline specific yet still system
899+
identifier sources that are discipline specific yet still system
900900
independent. As an example, the equivalent [ELIXIR Tools and Data
901901
Service Registry](https://bio.tools) IRI to the previous RRID example is
902902
https://bio.tools/tool/bowtie2/version/2.2.8.
903903
If supported by a given registry, implementations are encouraged to
904-
query these system independent sofware identifier IRIs directly for
904+
query these system independent software identifier IRIs directly for
905905
links to packaging systems.
906906
907907
A site specific IRI can be listed as well. For example, an academic
@@ -1293,7 +1293,7 @@ $graph:
12931293
For implementations that support reusing output from past work (on
12941294
the assumption that same code and same input produce same
12951295
results), control whether to enable or disable the reuse behavior
1296-
for a particular tool or step (to accomodate situations where that
1296+
for a particular tool or step (to accommodate situations where that
12971297
assumption is incorrect). A reused step is not executed but
12981298
instead returns the same output as the original execution.
12991299
@@ -1332,7 +1332,7 @@ $graph:
13321332
may apply their own security policies to restrict what is
13331333
accessible by the tool.
13341334
1335-
Enabling network access does not imply a publically routable IP
1335+
Enabling network access does not imply a publicly routable IP
13361336
address or the ability to accept inbound connections.
13371337
13381338
fields:
@@ -1369,7 +1369,7 @@ $graph:
13691369
read-only in every step.
13701370
13711371
Workflow steps which modify a file must produce the modified file
1372-
as output. Downstream steps which futher process the file must
1372+
as output. Downstream steps which further process the file must
13731373
use the output of previous steps, and not refer to a common input
13741374
(this is necessary for both ordering and correctness).
13751375

Process.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ $graph:
8282
If no `location` or `path` is specified, a file object must specify
8383
`contents` with the UTF-8 text content of the file. This is a "file
8484
literal". File literals do not correspond to external resources, but are
85-
created on disk with `contents` with when needed for a executing a tool.
85+
created on disk with `contents` with when needed for executing a tool.
8686
Where appropriate, expressions can return file literals to define new files
8787
on a runtime. The maximum size of `contents` is 64 kilobytes.
8888
@@ -168,7 +168,7 @@ $graph:
168168
executed. This field must be set by the implementation. The final
169169
path component must match the value of `basename`. This field
170170
must not be used in any other context. The command line tool being
171-
executed must be able to to access the file at `path` using the POSIX
171+
executed must be able to access the file at `path` using the POSIX
172172
`open(2)` syscall.
173173
174174
As a special case, if the `path` field is provided but the `location`
@@ -216,7 +216,7 @@ $graph:
216216
doc: |
217217
The basename root such that `nameroot + nameext == basename`, and
218218
`nameext` is empty or begins with a period and contains at most one
219-
period. For the purposess of path splitting leading periods on the
219+
period. For the purposes of path splitting leading periods on the
220220
basename are ignored; a basename of `.cshrc` will have a nameroot of
221221
`.cshrc`.
222222
@@ -235,7 +235,7 @@ $graph:
235235
- name: checksum
236236
type: string?
237237
doc: |
238-
Optional hash code for validating file integrity. Currently must be in the form
238+
Optional hash code for validating file integrity. Currently, must be in the form
239239
"sha1$ + hexadecimal string" using the SHA-1 algorithm.
240240
- name: size
241241
type:
@@ -266,7 +266,7 @@ $graph:
266266
identity: true
267267
doc: |
268268
The format of the file: this must be an IRI of a concept node that
269-
represents the file format, preferrably defined within an ontology.
269+
represents the file format, preferably defined within an ontology.
270270
If no ontology is available, file formats may be tested by exact match.
271271
272272
Reasoning about format compatibility must be done by checking that an
@@ -289,7 +289,7 @@ $graph:
289289
`location` field. When the file is staged as input to CommandLineTool,
290290
the value of `contents` must be written to a file.
291291
292-
If `contents` is set as a result of an Javascript expression,
292+
If `contents` is set as a result of a Javascript expression,
293293
an `entry` in `InitialWorkDirRequirement`, or read in from
294294
`cwl.output.json`, there is no specified upper limit on the
295295
size of `contents`. Implementations may have practical limits
@@ -392,7 +392,7 @@ $graph:
392392
The local path where the Directory is made available prior to executing a
393393
CommandLineTool. This must be set by the implementation. This field
394394
must not be used in any other context. The command line tool being
395-
executed must be able to to access the directory at `path` using the POSIX
395+
executed must be able to access the directory at `path` using the POSIX
396396
`opendir(2)` syscall.
397397
398398
If the `path` contains [POSIX shell metacharacters](http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02)
@@ -591,7 +591,7 @@ $graph:
591591
592592
This must be one or more IRIs of concept nodes
593593
that represents file formats which are allowed as input to this
594-
parameter, preferrably defined within an ontology. If no ontology is
594+
parameter, preferably defined within an ontology. If no ontology is
595595
available, file formats may be tested by exact match.
596596
597597
@@ -888,7 +888,7 @@ $graph:
888888
CommandLineTool, Workflow, or ExpressionTool.
889889
890890
If provided, then this must be an IRI of a concept node that
891-
represents the type of operation, preferrably defined within an ontology.
891+
represents the type of operation, preferably defined within an ontology.
892892
893893
For example, in the domain of bioinformatics, one can use an IRI from
894894
the EDAM Ontology's [Operation concept nodes](http://edamontology.org/operation_0004),
@@ -903,7 +903,7 @@ $graph:
903903
doc: |
904904
Indicates that the workflow platform must support inline Javascript expressions.
905905
If this requirement is not present, the workflow platform must not perform expression
906-
interpolatation.
906+
interpolation.
907907
fields:
908908
- name: class
909909
type:

Workflow.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ $graph:
312312
workflow inputs, or the outputs of other workflows steps) with the input
313313
parameters of the process specified by the `run` field. Only input parameters
314314
declared by the target process will be passed through at runtime to the process
315-
though additonal parameters may be specified (for use within `valueFrom`
315+
though additional parameters may be specified (for use within `valueFrom`
316316
expressions for instance) - unconnected or unused parameters do not represent an
317317
error condition.
318318
@@ -361,7 +361,7 @@ $graph:
361361
362362
# Picking non-null values among inbound data links
363363
364-
If present, `pickValue` specifies how to picking non-null values among inbound data links.
364+
If present, `pickValue` specifies how to pick non-null values among inbound data links.
365365
366366
`pickValue` is evaluated
367367
1. Once all source values from upstream step or parameters are available.
@@ -373,7 +373,7 @@ $graph:
373373
steps may be connected to a single input (`source` is a list), and
374374
skipped steps produce null values.
375375
376-
Static type checkers should check for type consistency after infering what the type
376+
Static type checkers should check for type consistency after inferring what the type
377377
will be after `pickValue` is applied, just as they do currently for `linkMerge`.
378378
379379
* **first_non_null**
@@ -556,7 +556,7 @@ $graph:
556556
Conditionals in CWL are an optional feature and are not required
557557
to be implemented by all consumers of CWL documents. An
558558
implementation that does not support conditionals must return a
559-
fatal error when attempting execute a workflow that uses
559+
fatal error when attempting to execute a workflow that uses
560560
conditional constructs the implementation does not support.
561561
562562
# Subworkflows
@@ -726,7 +726,7 @@ $graph:
726726
- name: steps
727727
doc: |
728728
The individual steps that make up the workflow. Each step is executed when all of its
729-
input data links are fufilled. An implementation may choose to execute
729+
input data links are fulfilled. An implementation may choose to execute
730730
the steps in a different order than listed and/or execute steps
731731
concurrently, provided that dependencies between steps are met.
732732
type:

concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ subworkflow steps, and so on. Embedded process objects may optionally
347347
include `id` fields.
348348

349349
A "$graph" document does not have a process object at the root.
350-
Instead there is a [`$graph`](SchemaSalad.html#Document_graph) field
350+
Instead, there is a [`$graph`](SchemaSalad.html#Document_graph) field
351351
which consists of a list of process objects. Each process object must
352352
have an `id` field. Workflow `run` fields cross-reference other
353353
processes in the document `$graph` using the `id` of the process

invocation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ For compatibility, files may be written to the **system temporary directory**
7070
which must be located at `/tmp`. Because the system temporary directory may be
7171
shared with other processes on the system, files placed in the system temporary
7272
directory are not guaranteed to be deleted automatically. A tool
73-
must not use the system temporary directory as a backchannel communication with
73+
must not use the system temporary directory as a back-channel communication with
7474
other tools. It is valid for the system temporary directory to be the same as
7575
the designated temporary directory.
7676

@@ -98,7 +98,7 @@ systems.
9898
An implementation may forbid the tool from directly accessing network
9999
resources. Correct tools must not assume any network access unless they have
100100
the 'networkAccess' field of a ['NetworkAccess'](#NetworkAccess) requirement set
101-
to `true` but even then this does not imply a publically routable IP address or
101+
to `true` but even then this does not imply a publicly routable IP address or
102102
the ability to accept inbound connections.
103103

104104
The `runtime` section available in [parameter references](#Parameter_references)

0 commit comments

Comments
 (0)