Skip to content

Commit e0e3e2a

Browse files
committed
Update docstrings
1 parent 80d3976 commit e0e3e2a

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

python/src/softfloatpy/_core.pyi

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1218,6 +1218,8 @@ class Float16:
12181218
def neg(self) -> Self:
12191219
"""Negates the IEEE 754 binary16 floating point.
12201220
1221+
The result is the same as that of :func:`f16_neg()`.
1222+
12211223
Returns:
12221224
The resulted number (``-x``).
12231225
@@ -1729,6 +1731,8 @@ class Float32:
17291731
def neg(self) -> Self:
17301732
"""Negates the IEEE 754 binary32 floating point.
17311733
1734+
The result is the same as that of :func:`f32_neg()`.
1735+
17321736
Returns:
17331737
The resulted number (``-x``).
17341738
@@ -2229,6 +2233,8 @@ class Float64:
22292233
def neg(self) -> Self:
22302234
"""Negates the IEEE 754 binary64 floating point.
22312235
2236+
The result is the same as that of :func:`f64_neg()`.
2237+
22322238
Returns:
22332239
The resulted number (``-x``).
22342240
@@ -2741,6 +2747,8 @@ class Float128:
27412747
def neg(self) -> Self:
27422748
"""Negates the IEEE 754 binary128 floating point.
27432749
2750+
The result is the same as that of :func:`f128_neg()`.
2751+
27442752
Returns:
27452753
The resulted number (``-x``).
27462754

python/src/softfloatpy/_core.pyx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1441,6 +1441,8 @@ cdef class Float16:
14411441
cpdef Float16 neg(self):
14421442
"""Negates the IEEE 754 binary16 floating point.
14431443
1444+
The result is the same as that of :func:`f16_neg()`.
1445+
14441446
Returns:
14451447
The resulted number (``-x``).
14461448
@@ -1985,6 +1987,8 @@ cdef class Float32:
19851987
cpdef Float32 neg(self):
19861988
"""Negates the IEEE 754 binary32 floating point.
19871989
1990+
The result is the same as that of :func:`f32_neg()`.
1991+
19881992
Returns:
19891993
The resulted number (``-x``).
19901994
@@ -2524,6 +2528,8 @@ cdef class Float64:
25242528
cpdef Float64 neg(self):
25252529
"""Negates the IEEE 754 binary64 floating point.
25262530
2531+
The result is the same as that of :func:`f64_neg()`.
2532+
25272533
Returns:
25282534
The resulted number (``-x``).
25292535
@@ -3099,6 +3105,8 @@ cdef class Float128:
30993105
cpdef Float128 neg(self):
31003106
"""Negates the IEEE 754 binary128 floating point.
31013107
3108+
The result is the same as that of :func:`f128_neg()`.
3109+
31023110
Returns:
31033111
The resulted number (``-x``).
31043112

0 commit comments

Comments
 (0)