Skip to content

Commit ad4cb0f

Browse files
authored
Improve Half docs a bit (#6663)
1 parent c54ce25 commit ad4cb0f

File tree

2 files changed

+19
-8
lines changed

2 files changed

+19
-8
lines changed

xml/System/Half.xml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,19 @@
3434
</Attribute>
3535
</Attributes>
3636
<Docs>
37-
<summary>An IEEE 754 compliant <see langword="float16" /> type.</summary>
38-
<remarks>To be added.</remarks>
37+
<summary>Represents a half-precision floating-point number.</summary>
38+
<remarks>
39+
<format type="text/markdown"><![CDATA[
40+
41+
## Remarks
42+
43+
The <xref:System.Half> value type represents a half-precision 16-bit number with values ranging from negative 65,504 to positive 65,504, as well as positive or negative zero, <xref:System.Half.PositiveInfinity>, <xref:System.Half.NegativeInfinity>, and not a number (<xref:System.Half.NaN>).
44+
45+
This is an IEEE 754-compliant <see langword="float16" /> type.
46+
47+
]]></format>
48+
</remarks>
49+
<seealso cref="T:System.Single" />
3950
</Docs>
4051
<Members>
4152
<Member MemberName="CompareTo">

xml/System/Single.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,17 +87,17 @@
8787
## Remarks
8888
The <xref:System.Single> value type represents a single-precision 32-bit number with values ranging from negative 3.402823e38 to positive 3.402823e38, as well as positive or negative zero, <xref:System.Single.PositiveInfinity>, <xref:System.Single.NegativeInfinity>, and not a number (<xref:System.Single.NaN>). It is intended to represent values that are extremely large (such as distances between planets or galaxies) or extremely small (such as the molecular mass of a substance in kilograms) and that often are imprecise (such as the distance from earth to another solar system). The <xref:System.Single> type complies with the IEC 60559:1989 (IEEE 754) standard for binary floating-point arithmetic.
8989
90-
This topic consists of the following sections:
90+
This article consists of the following sections:
9191
92-
- [Floating-point representation and precision](#Precision)
92+
- [Floating-point representation and precision](#Precision)
9393
94-
- [Testing for equality](#Equality)
94+
- [Testing for equality](#Equality)
9595
96-
- [Floating-point values and exceptions](#Exceptions)
96+
- [Floating-point values and exceptions](#Exceptions)
9797
98-
- [Type conversion and the Single structure](#Conversion)
98+
- [Type conversion and the Single structure](#Conversion)
9999
100-
- [Floating-point functionality](#Functionality)
100+
- [Floating-point functionality](#Functionality)
101101
102102
<xref:System.Single?displayProperty=nameWithType> provides methods to compare instances of this type, to convert the value of an instance to its string representation, and to convert the string representation of a number to an instance of this type. For information about how format specification codes control the string representation of value types, see [Formatting Types](/dotnet/standard/base-types/formatting-types), [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings), and [Custom Numeric Format Strings](/dotnet/standard/base-types/custom-numeric-format-strings).
103103

0 commit comments

Comments
 (0)