docs: improve code documentation

[poolifier.git] / src / utils.ts

diff --git a/src/utils.ts b/src/utils.ts
index 6d11f88cf6d964bfc9f36fe79b5c3eda3810d35b..7ac4ab25db67446a49b2fc42a0f219c043d4af6f 100644 (file)
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -73,6 +73,7 @@ export const median = (dataSet: number[]): number => {
 
 /**
  * Rounds the given number to the given scale.
+ * The rounding is done using the "round half away from zero" method.
  *
  * @param num - The number to round.
  * @param scale - The scale to round to.