Merge pull request #72 from tpapp/tp/document-slots

Document that slots can be accessed as part of the API.

Author: tpapp

Project.toml

@@ -5,6 +5,7 @@ version = "0.5.1"
 
 [deps]
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
+DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 FFTW = "7a1cc6ca-52ef-59f5-83cd-3a7055c09341"
 Interpolations = "a98d9a8b-a2ab-59e6-89dd-64a1c18fca59"
 Optim = "429524aa-4258-5aef-a3af-852621145aeb"

src/KernelDensity.jl

@@ -1,5 +1,6 @@
 module KernelDensity
 
+using DocStringExtensions: TYPEDEF, FIELDS
 using StatsBase
 using Distributions
 using Optim

src/bivariate.jl

@@ -1,7 +1,24 @@
-# Store both grid and density for KDE over R2
+"""
+$(TYPEDEF)
+
+Store both grid and density for KDE over the real line.
+
+Reading the fields directly is part of the API, and
+
+```julia
+sum(density) * step(x) * step(y) ≈ 1
+```
+
+# Fields
+
+$(FIELDS)
+"""
 mutable struct BivariateKDE{Rx<:AbstractRange,Ry<:AbstractRange} <: AbstractKDE
+    "First coordinate of gridpoints for evaluating the density."
     x::Rx
+    "Second coordinate of gridpoints for evaluating the density."
     y::Ry
+    "Kernel density at corresponding gridpoints `Tuple.(x, permutedims(y))`."
     density::Matrix{Float64}
 end
 

src/univariate.jl

@@ -1,6 +1,22 @@
-# Store both grid and density for KDE over the real line
+"""
+$(TYPEDEF)
+
+Store both grid and density for KDE over ``ℝ²``.
+
+Reading the fields directly is part of the API, and
+
+```julia
+sum(density) * step(x) ≈ 1
+```
+
+# Fields
+
+$(FIELDS)
+"""
 mutable struct UnivariateKDE{R<:AbstractRange} <: AbstractKDE
+    "Gridpoints for evaluating the density."
     x::R
+    "Kernel density at corresponding gridpoints `x`."
     density::Vector{Float64}
 end