Skip to content

[Repo Assist] Add doc comments to 20 undocumented top-level Oak DU types and interfaces#3281

Merged
nojaf merged 1 commit intomainfrom
repo-assist/improve-syntaxoak-du-doc-comments-20260312-3786f35af5294347
Mar 12, 2026
Merged

[Repo Assist] Add doc comments to 20 undocumented top-level Oak DU types and interfaces#3281
nojaf merged 1 commit intomainfrom
repo-assist/improve-syntaxoak-du-doc-comments-20260312-3786f35af5294347

Conversation

@github-actions
Copy link
Contributor

🤖 This PR was created by Repo Assist, an automated AI assistant. Please review carefully.

Continues the documentation improvement effort from PRs #3249, #3252, and #3261. All remaining undocumented top-level type declarations in SyntaxOak.fs now carry a /// doc comment explaining their role in the Oak intermediate representation.

Types documented (20 total)

Type What it represents
TriviaContent Trivia kind DU (comments, blank lines, directives, cursor)
Node (interface) Base interface for every Oak node
NodeBase (abstract class) Shared trivia-queue implementation
IdentifierOrDot One element of a dotted qualified identifier
Type DU for all F# type expressions
Pattern DU for all F# patterns
InheritConstructor Constructor argument forms following inherit
ComputationExpressionStatement A single statement in a CE body
InfixApp (interface) Marker for infix-application node types
ChainLink A single link in a method-call / property-access chain
StaticOptimizationConstraint Compiler-internal static optimisation constraint
Expr DU for all F# expressions
Open The two forms of open declaration
ITypeDefn (interface) Common interface for type-definition node types
TypeDefn DU for all type-definition forms
MemberDefn DU for all member definitions
Constant DU for literal constants
TyparDecls DU for type-parameter declaration styles
TypeConstraint DU for all type-constraint forms
RationalConstNode DU for unit-of-measure rational exponents

No logic changes — purely documentation.

Test Status

  • ✅ Build: dotnet build src/Fantomas.Core/Fantomas.Core.fsproj — succeeded, 0 warnings
  • ✅ Tests: dotnet test src/Fantomas.Core.Tests/2737 passed, 0 failed, 7 skipped

Generated by Repo Assist ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@346204513ecfa08b81566450d7d599556807389f

…aces

Continues the documentation improvement effort from PRs #3249, #3252, and
#3261. All remaining undocumented top-level type declarations in SyntaxOak.fs
now carry a /// doc comment explaining their role in the Oak intermediate
representation.

Types documented:
- TriviaContent — trivia kind enum (comments, blank lines, directives, cursor)
- Node (interface) — base interface for all Oak nodes
- NodeBase (abstract class) — shared trivia-queue implementation
- IdentifierOrDot — element of a dotted qualified identifier
- Type — DU for all F# type expressions
- Pattern — DU for all F# patterns
- InheritConstructor — constructor argument forms after 'inherit'
- ComputationExpressionStatement — statement in a CE body
- InfixApp (interface) — marker for infix-application nodes
- ChainLink — link in a method-call/property-access chain
- StaticOptimizationConstraint — compiler-internal optimisation constraint
- Expr — DU for all F# expressions
- Open — the two forms of open declaration
- ITypeDefn (interface) — common interface for type-definition nodes
- TypeDefn — DU for all type-definition forms
- MemberDefn — DU for all member definitions
- Constant — DU for literal constants
- TyparDecls — DU for type-parameter declaration styles
- TypeConstraint — DU for all type-constraint forms
- RationalConstNode — DU for unit-of-measure rational exponents

No logic changes — purely documentation.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@nojaf nojaf closed this Mar 12, 2026
@nojaf nojaf reopened this Mar 12, 2026
@nojaf nojaf marked this pull request as ready for review March 12, 2026 13:56
@nojaf nojaf enabled auto-merge March 12, 2026 13:56
@nojaf nojaf merged commit 9e8ba5d into main Mar 12, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant