Skip to content

[Repo Assist] Add XML doc comments to JsonValue.fs (batch 2 of #1678)#1686

Merged
dsyme merged 2 commits intomainfrom
repo-assist/docs-issue-1678-batch2-jsonvalue-dad13afa2b48079a
Mar 1, 2026
Merged

[Repo Assist] Add XML doc comments to JsonValue.fs (batch 2 of #1678)#1686
dsyme merged 2 commits intomainfrom
repo-assist/docs-issue-1678-batch2-jsonvalue-dad13afa2b48079a

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Mar 1, 2026

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

Part of #1678 — adds XML doc comments to JsonValue.fs.

What's changed

src/FSharp.Data.Json.Core/JsonValue.fs

Added doc comments to the JsonValue discriminated union cases:

  • String of string — A JSON string value
  • Number of decimal — A JSON number stored as decimal
  • Float of float — A JSON number stored as float (for large values)
  • Record of properties — A JSON object
  • Array of elements — A JSON array
  • Boolean of bool — A JSON boolean
  • Null — JSON null

Upgraded WriteTo and ToString overloads to full <summary>/(param)/(returns) XML doc comments.

Upgraded Parse, TryParse, Load, AsyncLoad, ParseMultiple, Request, and RequestAsync to full XML doc comments with param and return documentation.

Test Status

  • ✅ Build: succeeded (2 pre-existing warnings, 0 errors)
  • ✅ Fantomas format check: passed

Note: This issue should remain open per the maintainer's request — not using "Fixes" or "Closes" for issue #1678.

Generated by Repo Assist

To install this agentic workflow, run

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

Add comprehensive doc comments to JsonValue:
- Document DU cases: String, Number, Float, Record, Array, Boolean, Null
- Add param/return XML docs to WriteTo, ToString overloads
- Add param/return XML docs to Parse, TryParse, Load, AsyncLoad, ParseMultiple
- Add param/return XML docs to Request and RequestAsync

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@dsyme dsyme marked this pull request as ready for review March 1, 2026 13:37
@dsyme dsyme merged commit 77e3ee1 into main Mar 1, 2026
2 checks passed
@dsyme dsyme deleted the repo-assist/docs-issue-1678-batch2-jsonvalue-dad13afa2b48079a branch March 1, 2026 13:37
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