Type annotations #6278
Draft
Type annotations #6278
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
bentsherman
force-pushed
the
type-annotations
branch
4 times, most recently
from
d737101 to
59f9378
Compare
|
|
||
| <h3>Type annotations</h3> | ||
|
|
||
| Type annotations are a way to denote the *type* of a variable. They are useful both for documenting and validating your pipeline code. |
There was a problem hiding this comment.
Suggested change
| Type annotations are a way to denote the *type* of a variable. They are useful both for documenting and validating your pipeline code. | |
| You can use type annotations to denote the **type** of a variable. They help document and validate your pipeline code. |
| } | ||
| ``` | ||
|
|
||
| The following declarations can be annotated with types: |
There was a problem hiding this comment.
Suggested change
| The following declarations can be annotated with types: | |
| You can annotate the following declarations with types: |
|
|
||
| Type annotations can refer to any of the {ref}`standard types <stdlib-types>`. | ||
|
|
||
| Type annotations can be appended with `?` to denote that the value can be `null`: |
There was a problem hiding this comment.
Suggested change
| Type annotations can be appended with `?` to denote that the value can be `null`: | |
| You can append an `?` to type annotations to denote that the value can be `null`: |
| ``` | ||
|
|
||
| :::{note} | ||
| While Nextflow inherited type annotations of the form `<type> <name>` from Groovy, this syntax was deprecated in the {ref}`strict syntax <strict-syntax-page>`. Groovy-style type annotations are still allowed for functions and local variables, but will be automatically converted to Nextflow-stype type annotations when formatting code with the language server or `nextflow lint`. |
There was a problem hiding this comment.
Suggested change
| While Nextflow inherited type annotations of the form `<type> <name>` from Groovy, this syntax was deprecated in the {ref}`strict syntax <strict-syntax-page>`. Groovy-style type annotations are still allowed for functions and local variables, but will be automatically converted to Nextflow-stype type annotations when formatting code with the language server or `nextflow lint`. | |
| Nextflow previously inherited type annotations in the form `<type> <name>` from Groovy, but this syntax is now deprecated under the <strict-syntax-page>`. Groovy-style type annotations are still allowed for functions and local variables. However, the language server and `nextflow lint` will automatically convert them to Nextflow-style type annotations when formatting code. |
| def meta: Map = [:] | ||
| ``` | ||
|
|
||
| While Groovy-style type annotations are still supported, the linter and language server will automatically convert them to Nextflow-style type annotations when formatting code. Groovy-style type annotations will not be supported in a future version. |
There was a problem hiding this comment.
Suggested change
| While Groovy-style type annotations are still supported, the linter and language server will automatically convert them to Nextflow-style type annotations when formatting code. Groovy-style type annotations will not be supported in a future version. | |
| Groovy-style type annotations are supported. However, the language server and `nextflow lint` will automatically convert them to Nextflow-style type annotations when formatting code. Groovy-style type annotations will not be supported in a future version. |
docs/strict-syntax.md
Outdated
| @@ -368,21 +380,26 @@ def map = (Map) readJson(json) // soft cast | |||
| def map = readJson(json) as Map // hard cast | |||
| ``` | |||
|
|
|||
| In the strict syntax, only hard casts are supported. However, hard casts are discouraged because they can cause unexpected behavior if used improperly. Groovy-style type annotations should be used instead: | |||
| In the strict syntax, only hard casts are supported. | |||
There was a problem hiding this comment.
Suggested change
| In the strict syntax, only hard casts are supported. | |
| Only hard casts are supported in the strict syntax. |
docs/strict-syntax.md
Outdated
| In the strict syntax, only hard casts are supported. However, hard casts are discouraged because they can cause unexpected behavior if used improperly. Groovy-style type annotations should be used instead: | ||
| In the strict syntax, only hard casts are supported. | ||
|
|
||
| When casting a value to a different type, it is always better to use an explicit method if one is available. For example, to parse a string as a number: |
There was a problem hiding this comment.
Suggested change
| When casting a value to a different type, it is always better to use an explicit method if one is available. For example, to parse a string as a number: | |
| Always use an explicit method to cast a value to a different type if one is available. For example, to parse a string as a number: |
docs/strict-syntax.md
Outdated
|
|
||
| When converting a value to a different type, it is better to use an explicit method rather than a cast. For example, to parse a string as a number: | ||
| In cases where a function returns an unknown type, use a type annotation: |
There was a problem hiding this comment.
Suggested change
| In cases where a function returns an unknown type, use a type annotation: | |
| Use a type annotation when a function returns an unknown type: |
bentsherman
force-pushed
the
type-annotations
branch
from
59f9378 to
4c520f9
Compare
Signed-off-by: Ben Sherman <[email protected]>
bentsherman
force-pushed
the
type-annotations
branch
from
4c520f9 to
28157a6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds Nextflow-style type annotations for workflows, functions, and local variables.
Waiting for #5929 to be merged