Add remark for JsonNumberHandling of Special Numbers in System.Text.Json

[deeprobin]

Summary

See dotnet/runtime#48926

/cc @layomia
/cc @GrabYourPitchforks

[opbld30]

Docs Build status updates of commit 21db112:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/System.Text.Json.Serialization/JsonNumberHandling.xml	💡Suggestion	View	Details

xml/System.Text.Json.Serialization/JsonNumberHandling.xml

• Line 0, Column 0: [Suggestion: ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.

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

[ghost]

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

See dotnet/runtime#48926

/cc @layomia
/cc @GrabYourPitchforks

Author:	deeprobin
Assignees:	-
Labels:	area-System.Text.Json
Milestone:	-

[opbld34]

Docs Build status updates of commit 0974116:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/System.Text.Json.Serialization/JsonNumberHandling.xml	💡Suggestion	View	Details

xml/System.Text.Json.Serialization/JsonNumberHandling.xml

• Line 0, Column 0: [Suggestion: ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.

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

[opbld34]

Docs Build status updates of commit 99488ed:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/System.Text.Json.Serialization/JsonNumberHandling.xml	💡Suggestion	View	Details

xml/System.Text.Json.Serialization/JsonNumberHandling.xml

• Line 0, Column 0: [Suggestion: ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.

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

[opbld33]

Docs Build status updates of commit 138f228:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/System.Text.Json.Serialization/JsonNumberHandling.xml	💡Suggestion	View	Details

xml/System.Text.Json.Serialization/JsonNumberHandling.xml

• Line 0, Column 0: [Suggestion: ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.

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

[opbld31]

Docs Build status updates of commit fcd1862:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/System.Text.Json.Serialization/JsonNumberHandling.xml	💡Suggestion	View	Details

xml/System.Text.Json.Serialization/JsonNumberHandling.xml

• Line 0, Column 0: [Suggestion: ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.

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

[gewarren]

One thing to note is that currently, remarks on enum fields aren't displayed in the docs anywhere. You could add a general remark to the enum as a whole, and just call out the two fields specifically.

[deeprobin]

One thing to note is that currently, remarks on enum fields aren't displayed in the docs anywhere. You could add a general remark to the enum as a whole, and just call out the two fields specifically.

@layomia What is your approach to this?

[opbld31]

Docs Build status updates of commit 4c70e4a:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/System.Text.Json.Serialization/JsonNumberHandling.xml	💡Suggestion	View	Details

xml/System.Text.Json.Serialization/JsonNumberHandling.xml

• Line 0, Column 0: [Suggestion: ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.

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

[opbld33]

Docs Build status updates of commit 48502c8:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/System.Text.Json.Serialization/JsonNumberHandling.xml	💡Suggestion	View	Details

xml/System.Text.Json.Serialization/JsonNumberHandling.xml

• Line 0, Column 0: [Suggestion: ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.

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

[deeprobin]

One thing to note is that currently, remarks on enum fields aren't displayed in the docs anywhere. You could add a general remark to the enum as a whole, and just call out the two fields specifically.

@layomia What is your approach to this?

@gewarren See dotnet/runtime#62690 (comment)

[opbld31]

Docs Build status updates of commit ae2a9ee:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/System.Text.Json.Serialization/JsonNumberHandling.xml	💡Suggestion	View	Details

xml/System.Text.Json.Serialization/JsonNumberHandling.xml

• Line 0, Column 0: [Suggestion: ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.

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

[gewarren]

Thanks @deeprobin