Skip to content

Commit f568c0e

Browse files
Proof read edits
Signed-off-by: Christopher Hakkaart <[email protected]>
1 parent 6822188 commit f568c0e

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

docs/module.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -196,14 +196,14 @@ Project L
196196
└── P2-template.sh
197197
```
198198

199-
Projects A contains a workflow that includes processes P1 and P2:
199+
Project A contains a workflow that includes processes P1 and P2:
200200

201201
```
202202
Project A
203203
└── main.nf
204204
```
205205

206-
Pipeline B contains a workflow that also includes process P1 and P2:
206+
Project B contains a workflow that also includes process P1 and P2:
207207

208208
```
209209
Project B
@@ -212,11 +212,11 @@ Project B
212212

213213
As the template files are stored with the modules inside the Project L, Projects A and B can include them without any changing any code. Future projects would also be able to include these modules by cloning Project L and including its module (if they were not available on the system).
214214

215-
Keeping the module template within the script path has several advantages beyond facilitating module sharing across pipelines:
215+
Beyond facilitating module sharing across pipelines, keeping the module template within the script path has several advantages, including:
216216

217-
1. Modules are self-contained
218-
2. Modules can be tested independently from the pipeline(s) that import them
219-
3. Modules can be made into libraries
217+
- Modules are self-contained.
218+
- Modules can be tested independently from the pipeline(s) that import them.
219+
- Modules can be made into libraries.
220220

221221
Organizing templates locations allows for a well-structured project. In projects with multiple modules that rely on templates, you can organize module scripts and their corresponding templates into logical groups. For example:
222222

@@ -276,7 +276,7 @@ Binary scripts must be placed in the module directory named `<module-dir>/resour
276276
Module binary scripts require a local or shared file system for the pipeline work directory, or {ref}`wave-page` when using cloud-based executors.
277277
:::
278278

279-
Scripts can also be stored at the pipeline level using the `bin` directory. See {ref}`bin directory <bundling-executable>` for more information.
279+
Scripts can also be stored at the pipeline level using the `bin` directory. See {ref}`bundling-executables` for more information.
280280

281281
## Sharing modules
282282

docs/process.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ workflow {
112112
```
113113

114114
:::{tip}
115-
As the location of the interpreter binary file can differ across platforms. Use `env` to resolve the interpreter's location instead of hard-coding the interpreter path. For example:
115+
Use `env` to resolve the interpreter's location instead of hard-coding the interpreter path. For example:
116116

117117
```
118118
#!/usr/bin/env python
@@ -160,7 +160,7 @@ In the above example, the process will execute one of several scripts depending
160160

161161
### Template
162162

163-
Process scripts can be externalized to **template** files and accessed using the `template` function in the script section. For example:
163+
Process scripts can be externalized to **template** files and reused across multiple processes. Templates can be accessed using the `template` function in the script section. For example:
164164

165165
```nextflow
166166
process templateExample {
@@ -176,7 +176,7 @@ workflow {
176176
}
177177
```
178178

179-
By default, Nextflow looks for template scripts in the `templates` directory, located alongside the Nextflow script that defines the process. A template can be reused across multiple processes. An absolute path can be used to specify a different template location. However, this practice is discouraged because it hinders pipeline portability.
179+
By default, Nextflow looks for template scripts in the `templates` directory, located alongside the Nextflow script that defines the process. An absolute path can be used to specify a different template location. However, this practice is discouraged because it hinders pipeline portability.
180180

181181
Templates can be tested independently of pipeline execution. However, variables prefixed with the dollar character (`$`) are interpreted as Nextflow variables when the template script is executed by Nextflow and Bash variables when executed directly. Consider the following template script:
182182

docs/sharing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,15 +108,15 @@ Executable scripts can be included in the pipeline `bin` directory located at th
108108
Each script should include a shebang line to specify the interpreter for the script.
109109

110110
:::{tip}
111-
As the location of the interpreter binary file can differ across platforms. Use `env` to resolve the interpreter's location instead of hard-coding the interpreter path. For example:
111+
Use `env` to resolve the interpreter's location instead of hard-coding the interpreter path. For example:
112112

113113
```
114114
#!/usr/bin/env python
115115
```
116116

117117
:::
118118

119-
Scripts placed in the `bin` directory must have executable permissions. Use the `chmod` command to grant the required permissions. For example:
119+
Scripts placed in the `bin` directory must have executable permissions. Use `chmod` to grant the required permissions. For example:
120120

121121
```
122122
chmod a+x bin/custom_script.py

0 commit comments

Comments
 (0)