Skip to content

Commit 4dc9945

Browse files
docs: Update feature flags page (#6504)
--------- Signed-off-by: Christopher Hakkaart <[email protected]> Signed-off-by: Ben Sherman <[email protected]> Co-authored-by: Ben Sherman <[email protected]>
1 parent 6cb22a1 commit 4dc9945

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/reference/feature-flags.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
# Feature flags
44

5-
Feature flags are used to introduce experimental or other opt-in features. They must be specified in the pipeline script.
5+
Feature flags enable experimental or other opt-in features. They must be specified in the pipeline script.
6+
7+
:::{warning}
8+
Feature flags with the `nextflow.preview` prefix can cause pipelines run with newer versions of Nextflow to fail due to breaking changes. Always consult the {ref}`migration notes <migrations-page>` before updating to a new Nextflow version.
9+
:::
610

711
`nextflow.enable.configProcessNamesValidation`
812
: :::{deprecated} 25.10.0
@@ -47,7 +51,7 @@ Feature flags are used to introduce experimental or other opt-in features. They
4751
: :::{versionadded} 24.04.0
4852
:::
4953
: :::{deprecated} 25.10.0
50-
This feature flag is no longer required to use workflow outputs.
54+
This feature flag is no longer supported. Workflow outputs are out of preview.
5155
:::
5256
: When `true`, enables the use of {ref}`workflow outputs <workflow-output-def>`.
5357

@@ -59,12 +63,11 @@ Feature flags are used to introduce experimental or other opt-in features. They
5963
: :::{versionadded} 24.04.0
6064
:::
6165
: :::{deprecated} 25.04.0
62-
This feature flag is no longer required to use topic channels.
66+
This feature flag is no longer supported. Topic channels are out of preview.
6367
:::
64-
: When `true`, enables {ref}`topic channels <channel-topic>` feature.
68+
: When `true`, enables the use of {ref}`topic channels <channel-topic>`.
6569

6670
`nextflow.preview.types`
6771
: :::{versionadded} 25.10.0
6872
:::
69-
: When `true`, enables the use of {ref}`typed processes <process-typed-page>`.
70-
: This feature flag must be enabled in every script that uses typed processes. Legacy processes can not be defined in scripts that enable this feature flag.
73+
: When `true`, enables the use of {ref}`typed processes <process-typed-page>`. Must be enabled in every script that uses typed processes. Legacy processes cannot be defined in scripts with this flag enabled.

0 commit comments

Comments
 (0)