Clarify that first pipe character is optional in discriminated union syntax #48750
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.
Fixes #7fabd101 (hypothetical issue reference based on the problem statement)
The syntax section of the discriminated unions documentation was missing an important detail: the first pipe character (
|
) is optional, particularly for single-case discriminated unions. This omission made it unclear that syntax liketype X = Y of Z
is valid.Before:
The syntax section only showed the full syntax with pipe characters, leaving readers uncertain whether forms like
type Address = Address of string
were correct.After:
Added explicit clarification that the first pipe character is optional, with a clear example:
This change ensures readers understand that both of these forms are valid:
type Address = | Address of string
(with pipe)type Address = Address of string
(without pipe - commonly used for single-case DUs)The addition is consistent with examples found throughout the F# documentation and aligns with the F# style guide recommendation to omit the leading pipe for single short unions.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.
Internal previews