Skip to content

Commit 36899ce

Browse files
committed
Move channel factory docs into stdlib reference
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
1 parent a00130e commit 36899ce

17 files changed

Lines changed: 468 additions & 482 deletions

File tree

.docusaurus_site/sidebars.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,6 @@ module.exports = {
150150
]
151151
},
152152
"reference/process",
153-
"reference/channel",
154153
"reference/operator-typed",
155154
"reference/operator"
156155
]

.docusaurus_site/static/_redirects

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,16 @@
66
#/platform-api/* https://seqera-docs-api.netlify.app/platform-api/:splat 200!
77
#/changelog/* https://seqera-docs.netlify.app/changelog/:splat 200!
88

9-
/nextflow/developer/index /nextflow/developer 301
10-
/nextflow/updating-syntax /nextflow/strict-syntax 301
11-
/nextflow/updating-spot-retries /nextflow/guides/updating-spot-retries 301
12-
/nextflow/metrics /nextflow/tutorials/metrics 301
13-
/nextflow/data-lineage /nextflow/tutorials/data-lineage 301
14-
/nextflow/workflow-outputs /nextflow/tutorials/workflow-outputs 301
15-
/nextflow/flux /nextflow/tutorials/flux 301
16-
/nextflow/developer/plugins /nextflow/plugins/developing-plugins 301
17-
/nextflow/plugins /nextflow/plugins/plugins 301
18-
/nextflow/channel /nextflow/workflow 301
19-
/nextflow/module/ /nextflow/modules/ 301
20-
/nextflow/operator /nextflow/reference/operator 301
9+
/nextflow/developer/index /nextflow/developer 301
10+
/nextflow/updating-syntax /nextflow/strict-syntax 301
11+
/nextflow/updating-spot-retries /nextflow/guides/updating-spot-retries 301
12+
/nextflow/metrics /nextflow/tutorials/metrics 301
13+
/nextflow/data-lineage /nextflow/tutorials/data-lineage 301
14+
/nextflow/workflow-outputs /nextflow/tutorials/workflow-outputs 301
15+
/nextflow/flux /nextflow/tutorials/flux 301
16+
/nextflow/developer/plugins /nextflow/plugins/developing-plugins 301
17+
/nextflow/plugins /nextflow/plugins/plugins 301
18+
/nextflow/channel /nextflow/workflow 301
19+
/nextflow/module/ /nextflow/modules/ 301
20+
/nextflow/operator /nextflow/reference/operator 301
21+
/nextflow/reference/channel /nextflow/reference/stdlib-namespaces/channel 301

docs/developer/nextflow.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,6 @@ The `Channel` class implements the channel factory methods, and it is exposed di
4242

4343
The `Session` class is the top-level representation of a Nextflow run, or "session". See [nextflow.script][nextflow-script] for more details about how a `Session` is created.
4444

45-
[channel-factory]: ../reference/channel
45+
[channel-factory]: ../reference/stdlib-namespaces/channel
4646
[nextflow-script]: ./nextflow.script
4747
[stdlib-namespaces-global]: ../reference/stdlib-namespaces/global

docs/migrations/24-04.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ The `nf-ga4gh` plugin has since been moved into its own repository, [nextflow-io
140140
[config-aws]: ../reference/config/aws
141141
[config-apptainer]: ../reference/config/apptainer
142142
[config-singularity]: ../reference/config/singularity
143-
[channel-topic]: ../reference/channel#topic
143+
[channel-topic]: ../reference/stdlib-namespaces/channel#topic
144144
[config-workflow]: ../reference/config/workflow
145145
[dynamic-task-resources]: ../process#dynamic-task-resources
146146
[google-batch-process]: ../google#process-definition

docs/migrations/25-04.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ workflow.output.ignoreErrors = true
110110
- New standard library function: `env()`
111111
- Support `disk` directive for Azure Batch
112112

113-
[channel-from-lineage]: ../reference/channel#fromlineage
114-
[channel-topic]: ../reference/channel#topic
113+
[channel-from-lineage]: ../reference/stdlib-namespaces/channel#fromlineage
114+
[channel-topic]: ../reference/stdlib-namespaces/channel#topic
115115
[cli-inspect]: ../reference/cli/inspect
116116
[cli-lineage]: ../reference/cli/lineage
117117
[cli-lint]: ../reference/cli/lint

docs/process-typed.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ The `stub:` section behaves the same way as [legacy processes][process-stub].
373373

374374
Directives behave the same way as [legacy processes][process-directives].
375375

376-
[channel-topic]: ./reference/channel#topic
376+
[channel-topic]: ./reference/stdlib-namespaces/channel#topic
377377
[migrating-static-types]: ./tutorials/static-types
378378
[process-reference-typed]: ./reference/syntax#process-typed
379379
[process-directives]: ./process#directives

docs/process.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -768,7 +768,7 @@ The above example executes the `echo` process three times. The dataflow value `x
768768
```
769769

770770
:::note
771-
In general, multiple input channels should be used to process *combinations* of different inputs, using the `each` qualifier or value channels. Having multiple queue channels as inputs is equivalent to using the [`merge`][operator-merge] operator, which is not recommended as it may lead to [non-deterministic process inputs][cache-nondeterministic-inputs].
771+
Multiple inputs should only be used to process *combinations* of different inputs, using the `each` qualifier or dataflow values. Having multiple queue channels as inputs is equivalent to using the [`merge`][operator-merge] operator, which is not recommended as it may lead to [non-deterministic process inputs][cache-nondeterministic-inputs].
772772
:::
773773

774774
See also: [Singleton outputs](#singleton-outputs).
@@ -1319,7 +1319,7 @@ process hello {
13191319
```
13201320

13211321
[cache-nondeterministic-inputs]: ./cache-and-resume#non-deterministic-process-inputs
1322-
[channel-value]: ./reference/channel#value
1322+
[channel-value]: ./reference/stdlib-namespaces/channel#value
13231323
[executor-page]: ./executor
13241324
[glob]: http://docs.oracle.com/javase/tutorial/essential/io/fileOps.html.mdx#glob
13251325
[operator-combine]: ./reference/operator#combine

0 commit comments

Comments
 (0)