Document new helper

FriendsOfPHP · Dec 4, 2023 · b984e12 · b984e12
1 parent fba6189
commit b984e12
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -35,6 +35,9 @@ echo Number::format(1234567.89); // 1 KB
 
 // Get a human-readable representation of a number
 echo Number::format(1234567.89); // 1 million
+
+// Get the abbreviated form of a number
+echo Number::format(1234567.89); // 1M
 ```
 
 ### Advanced usage

diff --git a/src/Number.php b/src/Number.php
@@ -120,7 +120,7 @@ public static function fileSize(int|float $bytes, int $precision = 0, ?int $maxP
     }
 
     /**
-     * Convert the number to its human-readable equivalent.
+     * Convert the number to its human-readable equivalent with abbreviated units.
      *
      * @param int|float $number
      * @param int $precision
@@ -133,7 +133,7 @@ public static function abbreviate(int|float $number, int $precision = 0, ?int $m
     }
 
     /**
-     * Convert the number to its human readable equivalent.
+     * Convert the number to its human-readable equivalent.
      *
      * @param  int  $number
      * @param  int  $precision
@@ -158,7 +158,7 @@ public static function forHumans(int|float $number, int $precision = 0, ?int $ma
     }
 
     /**
-     * Convert the number to its human readable equivalent.
+     * Convert the number to its human-readable equivalent.
      *
      * @param  int  $number
      * @param  int  $precision