Skip to content

Commit a1c0f7e

Browse files
authored
docs: fix notes
Signed-off-by: Athan <kgryte@gmail.com>
1 parent 8f3c201 commit a1c0f7e

File tree

1 file changed

+1
-2
lines changed
  • lib/node_modules/@stdlib/stats/base/ndarray/snanmeanors

1 file changed

+1
-2
lines changed

lib/node_modules/@stdlib/stats/base/ndarray/snanmeanors/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,7 @@ The function has the following parameters:
7878

7979
## Notes
8080

81-
- If `N <= 0`, both functions return `NaN`.
82-
- If every indexed element is `NaN`, both functions return `NaN`.
81+
- If provided an empty one-dimensional ndarray, the function returns `NaN`.
8382
- Ordinary recursive summation (i.e., a "simple" sum) is performant, but can incur significant numerical error. If performance is paramount and error tolerated, using ordinary recursive summation to compute an arithmetic mean is acceptable; in all other cases, exercise due caution.
8483

8584
</section>

0 commit comments

Comments
 (0)