aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authornsfisis <nsfisis@gmail.com>2025-10-19 00:23:57 +0900
committernsfisis <nsfisis@gmail.com>2025-10-19 00:23:57 +0900
commit7da51e3ed8b0a2fef94b82240def83ab24d5cac8 (patch)
treecbf0d4d127f782a73aeb4815c0dcffd445f941eb /README.md
parent761fafc46d0d2ae8791f4ef078c4ad164b6aee83 (diff)
downloadphp-next-after-7da51e3ed8b0a2fef94b82240def83ab24d5cac8.tar.gz
php-next-after-7da51e3ed8b0a2fef94b82240def83ab24d5cac8.tar.zst
php-next-after-7da51e3ed8b0a2fef94b82240def83ab24d5cac8.zip
docs: add PHPDoc to public functions
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 36b27b9..321b6a4 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ A PHP library that provides a port of Java's `Math.nextAfter()` family of functi
## Overview
-This library implements IEEE 754 floating-point manipulation functions that return the next representable floating-point value in a given direction:
+This library implements IEEE 754 floating-point manipulation functions that return the next representable floating-point number in a given direction:
- `nextAfter($x, $y)` - Returns the adjacent float in the direction of another value
- `nextUp($x)` - Returns the next float toward positive infinity
@@ -61,7 +61,7 @@ Returns the floating-point number adjacent to `$x` in the direction of `$y`. If
### `nextUp(float $x): float`
-Returns the floating-point value adjacent to `$x` in the direction of positive infinity.
+Returns the floating-point number adjacent to `$x` in the direction of positive infinity.
This is semantically equivalent to `nextAfter($x, INF)`.
@@ -75,7 +75,7 @@ This is semantically equivalent to `nextAfter($x, INF)`.
### `nextDown(float $x): float`
-Returns the floating-point value adjacent to `$x` in the direction of negative infinity.
+Returns the floating-point number adjacent to `$x` in the direction of negative infinity.
This is semantically equivalent to `nextAfter($x, -INF)`.