Mention dim keyword in readme

brenhinkeller · May 30, 2021 · 219e6a9 · 219e6a9 · brenhinkeller · May 30, 2021
1 parent fbc9844
commit 219e6a9
Showing 1 changed file with 2 additions and 1 deletion.
diff --git 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);