Update doc and generic parameter name for JsonValue.GetValue #56639
Conversation
This file contains 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
steveharter
added
documentation
|
Tagging subscribers to this area: @eiriktsarpalis, @layomia Issue DetailsAdds additional detail to the
|
steveharter
changed the title
stephentoub
reviewed
Jul 30, 2021
| @@ -595,7 +595,7 @@ public abstract partial class JsonNode | |||
| public System.Text.Json.Nodes.JsonObject AsObject() { throw null; } | |||
| public System.Text.Json.Nodes.JsonValue AsValue() { throw null; } | |||
| public string GetPath() { throw null; } | |||
| public virtual TValue GetValue<TValue>() { throw null; } | |||
| public virtual T GetValue<T>() { throw null; } | |||
There was a problem hiding this comment.
Same here. I don't think this needs an API review.
There was a problem hiding this comment.
Thanks (I was about to create a mail for this)
This was referenced Jul 30, 2021
Closed
| /// value supported by current <see cref="JsonElement"/>. | ||
| /// Specifying the <see cref="object"/> type for {T} will always succeed and return the underlying value as <see cref="object"/>.<br /> | ||
| /// The underlying value of a <see cref="JsonValue"/> after deserialization is an instance of <see cref="JsonElement"/>, | ||
| /// otherwise it's the value specified when the <see cref="JsonValue"/> was created. | ||
| /// </remarks> | ||
| /// <seealso cref="JsonNode.GetValue{TValue}"></seealso> |
There was a problem hiding this comment.
Doesn't this also need renaming?
Suggested change
| /// <seealso cref="JsonNode.GetValue{TValue}"></seealso> | |
| /// <seealso cref="JsonNode.GetValue{T}"></seealso> |
eiriktsarpalis
approved these changes
Aug 2, 2021
thaystg
added a commit
to thaystg/runtime
that referenced
this pull request
Aug 3, 2021
* origin/main: (64 commits) [wasm][debugger] Create test Inherited Properties (dotnet#56754) Mark new test as incompatible with GC Mark4781_1GcStressIncompatible (dotnet#56739) Ensure MetadataEnumResult is sufficiently updated by MetaDataImport::Enum (dotnet#56756) [mono] Remove gdb xdebug and binary writer support, it hasn't worked in a while. (dotnet#56759) Update windows-requirements.md (dotnet#56476) Update doc and generic parameter name for JsonValue.GetValue (dotnet#56639) [wasm][debugger] Inspect static class (dotnet#56740) Fix stack overflow handling issue in GC stress (dotnet#56733) Use ReflectionOnly as serialization mode in case dynamic code runtime feature is not supported (dotnet#56604) Move Windows Compat pack to NuGet pack task (dotnet#56686) Fix build error when building some packages (dotnet#56767) Simplify JIT shutdown logic in crossgen2 (dotnet#56687) Fix race in crossdac publishing with PGO (dotnet#56762) Add DictionaryKeyPolicy support for EnumConverter [dotnet#47765] (dotnet#54429) Use ComWrappers in some Marshal unit-tests and update platform metadata (dotnet#56595) Set `DisableImplicitNamespaceImports_Dotnet=true` to workaround sdk issue (dotnet#56744) Make sure ServerGCHeapDetails is up to date (dotnet#56056) [libraries] Reenable System.Diagnostics.DiagnosticSorce.Switches.Tests on mobile (dotnet#56737) Disable failing arm64 win10 Graphics.FromHdc tests (dotnet#56732) Match xplat event source conditions (dotnet#56435) ...
thaystg
added a commit
to thaystg/runtime
that referenced
this pull request
Aug 4, 2021
…ger_proxy_attribute * origin/main: (340 commits) add RID for Debian 11 (dotnet#56789) [wasm] [debugger] Skip thread static field (dotnet#56749) Fix timeouts in coreroot_determinism test in GC stress mode (dotnet#56770) Use File.OpenHandle in Socket.SendFile directly (dotnet#56777) accept empty realm for digest auth (dotnet#56369) (dotnet#56455) [wasm][debugger] Create test Inherited Properties (dotnet#56754) Mark new test as incompatible with GC Mark4781_1GcStressIncompatible (dotnet#56739) Ensure MetadataEnumResult is sufficiently updated by MetaDataImport::Enum (dotnet#56756) [mono] Remove gdb xdebug and binary writer support, it hasn't worked in a while. (dotnet#56759) Update windows-requirements.md (dotnet#56476) Update doc and generic parameter name for JsonValue.GetValue (dotnet#56639) [wasm][debugger] Inspect static class (dotnet#56740) Fix stack overflow handling issue in GC stress (dotnet#56733) Use ReflectionOnly as serialization mode in case dynamic code runtime feature is not supported (dotnet#56604) Move Windows Compat pack to NuGet pack task (dotnet#56686) Fix build error when building some packages (dotnet#56767) Simplify JIT shutdown logic in crossgen2 (dotnet#56687) Fix race in crossdac publishing with PGO (dotnet#56762) Add DictionaryKeyPolicy support for EnumConverter [dotnet#47765] (dotnet#54429) Use ComWrappers in some Marshal unit-tests and update platform metadata (dotnet#56595) ...
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Adds additional XML doc for the
GetValuemethods; in particular it wasn't obvious that passing in<object>for the generic parameter will always succeed and return the underlying value.In addition, the
JsonNode.GetValue<TValue>was changed toJsonNode.GetValue<T>to be consistent withJsonValue.TryGetValue<T>. Not sure on the guidance here, but I think consistency is better, and<TValue>seems redundant.