From 219e6a9af558d3e62661160b208fd3958214562d Mon Sep 17 00:00:00 2001 From: "C.Brenhin Keller" Date: Sun, 30 May 2021 13:24:26 -0400 Subject: [PATCH] Mention `dim` keyword in readme --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e2cb43..d7400da 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,8 @@ Summary statistics exported by NaNStatistics are generally named the same as the * `nanextrema` * `nanrange` (range between nanmaximum and nanminimum) -These functions will generally support the same `dims` keyword as their normal Julia counterparts (though are most efficient when operating on an entire collection). +These functions will generally support the same `dims` keyword argument as their normal Julia counterparts (though are most efficient when operating on an entire collection). +As an alternative to `dims`, the `dim` keyword is also supported, which behaves identially to `dims` except that it also (as is the norm in some other languages) drops any singleton dimensions that have been reduced over. ``` julia> a = rand(100000);