Skip to content

Commit 03712ec

Browse files
authored
Expand docstring on SynModuleDecl.Types (#18698)
1 parent c87a428 commit 03712ec

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/Compiler/SyntaxTree/SyntaxTree.fsi

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1731,7 +1731,15 @@ type SynModuleDecl =
17311731
/// An 'expr' within a module.
17321732
| Expr of expr: SynExpr * range: range
17331733

1734-
/// One or more 'type' definitions within a module
1734+
/// <summary>
1735+
/// A type definition group ('<c>type T1 ... and T2 ...</c>') or a single '<c>type</c>' definition within a module.
1736+
/// </summary>
1737+
///
1738+
/// <remarks>
1739+
/// Consecutive '<c>type</c>' keywords (e.g. <c>type T1 ... type T2 ...</c>) are represented individually, with
1740+
/// separate <c>Types</c> syntax tree nodes for each.
1741+
/// Only the '<c>and</c>' keyword causes multiple types to be aggregated into a single <c>Types</c> node.
1742+
/// </remarks>
17351743
| Types of typeDefns: SynTypeDefn list * range: range
17361744

17371745
/// An 'exception' definition within a module

0 commit comments

Comments
 (0)