docstring

joshday · Apr 21, 2020 · 65c0e3a · 65c0e3a
1 parent 48eea77
commit 65c0e3a
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/stats.jl b/src/stats.jl
@@ -59,6 +59,16 @@ Base.values(o::CountMap) = values(o.value)
 Base.getindex(o::CountMap, i) = o.value[i]
 
 #-----------------------------------------------------------------------------# CountMissing
+"""
+    CountMissing(stat)
+
+Calculate a `stat` along with the count of `missing` values.  
+
+# Example 
+
+    o = CountMissing(Mean())
+    fit!(o, [1, missing, 3])
+"""
 mutable struct CountMissing{T, O<:OnlineStat{T}} <: OnlineStat{Union{Missing,T}}
     stat::O
     nmissing::Int