Conversation
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
approved these changes
Mar 1, 2026
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
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 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.fsAdded doc comments to the
JsonValuediscriminated union cases:String of string— A JSON string valueNumber of decimal— A JSON number stored as decimalFloat of float— A JSON number stored as float (for large values)Record of properties— A JSON objectArray of elements— A JSON arrayBoolean of bool— A JSON booleanNull— JSON nullUpgraded
WriteToandToStringoverloads to full<summary>/(param)/(returns)XML doc comments.Upgraded
Parse,TryParse,Load,AsyncLoad,ParseMultiple,Request, andRequestAsyncto full XML doc comments with param and return documentation.Test Status