A Good Day to Doc Hard

.travis.yml

@@ -8,3 +8,4 @@ notifications:
   email: false
 after_success:
   - julia -e 'cd(Pkg.dir("DataArrays")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
+  # - julia -e 'cd(Pkg.dir("DataArrays")); Pkg.add("Documenter"); include(joinpath("docs", "make.jl"))'

README.md

@@ -4,10 +4,16 @@ DataArrays.jl
 [![Build Status](https://travis-ci.org/JuliaStats/DataArrays.jl.svg?branch=master)](https://travis-ci.org/JuliaStats/DataArrays.jl)
 [![Coverage Status](https://coveralls.io/repos/JuliaStats/DataArrays.jl/badge.svg?branch=master)](https://coveralls.io/r/JuliaStats/DataArrays.jl?branch=master)
 
+Latest release:
 [![DataArrays](http://pkg.julialang.org/badges/DataArrays_0.4.svg)](http://pkg.julialang.org/?pkg=DataArrays)
 [![DataArrays](http://pkg.julialang.org/badges/DataArrays_0.5.svg)](http://pkg.julialang.org/?pkg=DataArrays)
 [![DataArrays](http://pkg.julialang.org/badges/DataArrays_0.6.svg)](http://pkg.julialang.org/?pkg=DataArrays)
 
+Documentation:
+[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaStats.github.io/DataArrays.jl/stable)
+[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://JuliaStats.github.io/DataArrays.jl/latest)
+
+
 The DataArrays package extends Julia by introducing data structures that can contain missing data. In particular, the package introduces three new data types to Julia:
 
 * `NA`: A singleton type that represents a single missing value.

docs/src/da.md

@@ -23,6 +23,7 @@ isna
 allna
 anyna
 dropna
+padNA
 levels
 ```
 
@@ -37,4 +38,5 @@ setlevels!
 replace!
 PooledDataVecs
 getpoolidx
+reorder
 ```

src/datavector.jl

@@ -168,7 +168,24 @@ Base.sizehint!(pda::PooledDataVector, newsz::Integer) =
     sizehint!(pda.refs, newsz)
 
 # Pad a vector with NA's
-
+"""
+    padNA(dv::AbstractDataVector, front::Integer, back::Integer) -> DataVector
+
+Pad `dv` with `NA` values, `front` at the beginning of the array and `back` at the end.
+
+# Examples
+
+```jldoctest
+julia> padNA(@data([1, 2, 3]), 1, 2)
+6-element DataArrays.DataArray{Int64,1}:
+  NA
+ 1
+ 2
+ 3
+  NA
+  NA
+```
+"""
 function padNA(dv::AbstractDataVector,
                front::Integer,
                back::Integer)

src/pooleddataarray.jl

@@ -498,9 +498,15 @@ function setlevels!{T,R}(x::PooledDataArray{T,R}, d::Dict{T,Any}) # this version
     setlevels!(x, newpool)
 end
 
+"""
+    reorder(x::PooledDataArray) -> PooledDataArray
+
+Return a `PooledDataArray` containing the same data as `x` but with the value pool sorted.
+"""
 reorder(x::PooledDataArray) = PooledDataArray(x, sort(levels(x)))  # just re-sort the pool
 
-reorder(x::PooledDataArray, y::AbstractVector...) = reorder(mean, x, y...)
+### FIXME: this calls a method that doesn't exist
+# reorder(x::PooledDataArray, y::AbstractVector...) = reorder(mean, x, y...)
 
 ### FIXME: this can't work because we don't know about DataFrames
 # reorder(fun::Function, x::PooledDataArray, y::AbstractVector...) =