JsonElement and Utf8JsonReader consistency for TryParse... methods #7427

CodeCasterNL · 2021-11-26T14:06:04Z

Summary

Update docs to be consistent between JsonElement and Utf8JsonReader.

dnfadmin · 2021-11-26T14:06:16Z

All CLA requirements met.

ghost · 2021-11-26T14:06:20Z

Tagging subscribers to this area: @dotnet/area-system-text-json
See info in area-owners.md if you want to be subscribed.

Issue Details

Summary

Update docs to be consistent between JsonElement and Utf8JsonReader.

Fixes #7426

Author:	CodeCasterNL
Assignees:	-
Labels:	`area-System.Text.Json`
Milestone:	-

opbld34 · 2021-11-26T14:08:39Z

Docs Build status updates of commit 61e6c5e:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File	Status	Details
xml/System.Text.Json/JsonElement.xml	❌Error	Details
xml/System.Text.Json/Utf8JsonReader.xml	❌Error	Details
	❌Error	Details

xml/System.Text.Json/JsonElement.xml

Line 0, Column 0: [Error: ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The '?' character, hexadecimal value 0x3F, cannot be included in a name. Line 1158, position 188.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ParseElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

xml/System.Text.Json/Utf8JsonReader.xml

Line 0, Column 0: [Error: ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The '?' character, hexadecimal value 0x3F, cannot be included in a name. Line 1214, position 188.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ParseElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

Line 0, Column 0: [Error: ECMA2Yaml_File_LoadFailed] Failed to load 2 files, aborting...

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching the docs.microsoft.com contributor guides
Post your question in the Docs support channel

opbld34 · 2021-11-26T14:23:51Z

Docs Build status updates of commit 2131a5d:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File	Status	Details
xml/System.Text.Json/JsonElement.xml	❌Error	Details
xml/System.Text.Json/Utf8JsonReader.xml	❌Error	Details
	❌Error	Details

xml/System.Text.Json/JsonElement.xml

Line 0, Column 0: [Error: ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The '?' character, hexadecimal value 0x3F, cannot be included in a name. Line 1197, position 194.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ParseElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

xml/System.Text.Json/Utf8JsonReader.xml

Line 0, Column 0: [Error: ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The '?' character, hexadecimal value 0x3F, cannot be included in a name. Line 1253, position 194.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ParseElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

Line 0, Column 0: [Error: ECMA2Yaml_File_LoadFailed] Failed to load 2 files, aborting...

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching the docs.microsoft.com contributor guides
Post your question in the Docs support channel

…nd "Guid.Empty".

opbld33 · 2021-11-26T14:29:52Z

Docs Build status updates of commit a233aca:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File	Status	Details
xml/System.Text.Json/JsonElement.xml	❌Error	Details
xml/System.Text.Json/Utf8JsonReader.xml	❌Error	Details
	❌Error	Details

xml/System.Text.Json/JsonElement.xml

Line 0, Column 0: [Error: ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: 'xref' is an undeclared prefix. Line 1158, position 159.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.LookupNamespace(NodeData node)
   at System.Xml.XmlTextReaderImpl.ElementNamespaceLookup()
   at System.Xml.XmlTextReaderImpl.ParseElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

xml/System.Text.Json/Utf8JsonReader.xml

Line 0, Column 0: [Error: ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The '?' character, hexadecimal value 0x3F, cannot be included in a name. Line 1214, position 188.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ParseElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

Line 0, Column 0: [Error: ECMA2Yaml_File_LoadFailed] Failed to load 2 files, aborting...

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching the docs.microsoft.com contributor guides
Post your question in the Docs support channel

opbld33 · 2021-11-26T14:40:03Z

Docs Build status updates of commit 3682a17:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File	Status	Details
xml/System.Text.Json/JsonElement.xml	❌Error	Details
xml/System.Text.Json/Utf8JsonReader.xml	❌Error	Details
	❌Error	Details

xml/System.Text.Json/JsonElement.xml

Line 0, Column 0: [Error: ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The '?' character, hexadecimal value 0x3F, cannot be included in a name. Line 1197, position 194.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ParseElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

xml/System.Text.Json/Utf8JsonReader.xml

Line 0, Column 0: [Error: ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The '?' character, hexadecimal value 0x3F, cannot be included in a name. Line 1253, position 194.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ParseElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

Line 0, Column 0: [Error: ECMA2Yaml_File_LoadFailed] Failed to load 2 files, aborting...

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching the docs.microsoft.com contributor guides
Post your question in the Docs support channel

opbld32 · 2021-11-26T15:20:39Z

Docs Build status updates of commit 643b6e1:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/System.Text.Json/JsonElement.xml	✅Succeeded	View
xml/System.Text.Json/Utf8JsonReader.xml	✅Succeeded	View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

Try searching the docs.microsoft.com contributor guides
Post your question in the Docs support channel

xml/System.Text.Json/JsonElement.xml

gewarren

Thank you @CodeCasterNL! This is great.

#7426: JsonElement and Utf8JsonReader documentation consistency

61e6c5e

CodeCasterNL requested a review from a team as a code owner November 26, 2021 14:06

ghost added the area-System.Text.Json label Nov 26, 2021

Pleasing the parser

2131a5d

Then it'll be "MinValue" and "Empty" instead of "DateTime.MinValue" a…

a233aca

…nd "Guid.Empty".

Complains about consistency, consistently copy-pastes incorrect XML

3682a17

This should be the last ones

643b6e1

eiriktsarpalis reviewed Nov 29, 2021

View reviewed changes

xml/System.Text.Json/JsonElement.xml Show resolved Hide resolved

eiriktsarpalis approved these changes Nov 29, 2021

View reviewed changes

gewarren approved these changes Nov 29, 2021

View reviewed changes

gewarren merged commit 6f40084 into dotnet:main Nov 29, 2021

CodeCasterNL deleted the feature/7426_JsonTryParse branch June 7, 2022 22:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

JsonElement and Utf8JsonReader consistency for TryParse... methods #7427

JsonElement and Utf8JsonReader consistency for TryParse... methods #7427

Uh oh!

CodeCasterNL commented Nov 26, 2021

Uh oh!

dnfadmin commented Nov 26, 2021 •

edited

Loading

Uh oh!

ghost commented Nov 26, 2021

Summary

Uh oh!

opbld34 commented Nov 26, 2021

Uh oh!

opbld34 commented Nov 26, 2021

Uh oh!

opbld33 commented Nov 26, 2021

Uh oh!

opbld33 commented Nov 26, 2021

Uh oh!

opbld32 commented Nov 26, 2021

Uh oh!

Uh oh!

gewarren left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

JsonElement and Utf8JsonReader consistency for TryParse... methods #7427

JsonElement and Utf8JsonReader consistency for TryParse... methods #7427

Uh oh!

Conversation

CodeCasterNL commented Nov 26, 2021

Summary

Uh oh!

dnfadmin commented Nov 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Nov 26, 2021

Summary

Uh oh!

opbld34 commented Nov 26, 2021

❌ Validation status: errors

Uh oh!

opbld34 commented Nov 26, 2021

❌ Validation status: errors

Uh oh!

opbld33 commented Nov 26, 2021

❌ Validation status: errors

Uh oh!

opbld33 commented Nov 26, 2021

❌ Validation status: errors

Uh oh!

opbld32 commented Nov 26, 2021

✅ Validation status: passed

Uh oh!

Uh oh!

gewarren left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

dnfadmin commented Nov 26, 2021 •

edited

Loading