Skip to content

Commit a9ff4c6

Browse files
authored
RuntimeInformation.OSDescription: add intended use-case. (#8968)
1 parent b209640 commit a9ff4c6

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

xml/System.Runtime.InteropServices/RuntimeInformation.xml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,8 +244,18 @@ The returned value is intended to represent the actual architecture of the under
244244
</ReturnValue>
245245
<Docs>
246246
<summary>Gets a string that describes the operating system on which the app is running.</summary>
247-
<value>The description of the operating system on which the app is running.</value>
248-
<remarks>To be added.</remarks>
247+
<value>An opaque string that describes the operating system on which the app is running.</value>
248+
<remarks>
249+
<format type="text/markdown"><![CDATA[
250+
251+
## Remarks
252+
253+
This property returns a string that describes the operating system for presentation to the user.
254+
255+
It's not recommended to parse the string for information.
256+
257+
]]></format>
258+
</remarks>
249259
</Docs>
250260
</Member>
251261
<Member MemberName="ProcessArchitecture">

0 commit comments

Comments
 (0)