Docs: update transform docstring

README.md

@@ -106,8 +106,9 @@ My TODO over the next while is:
 - [x] Add tests
 - [x] Better error handling
 - [x] Compile docs and run tests using Actions
+- [x] Check for valid country x table x group combos
+- [x] Add function to transform long-form `DataFrames` into $age \times year$ `DataFrames`
 - [ ] Think about how to handle 'secret' credentials (testing and general use)
-- [ ] Check for valid country x table x group combos
 - [ ] Make it compatible with [MortalityTables.jl](https://github.com/JuliaActuary/MortalityTables.jl)
 
 ## License

src/HMD.jl

@@ -225,7 +225,7 @@ function get_tables()::Dict{String, String}
 end
 
 """
-  `get_groups()`
+  `get_groups()::Vector{String}`
 
 Returns a `Vector` of valid groupings (i.e. "1x1", "1x5", etc.)
 """
@@ -235,7 +235,7 @@ function get_groups()::Vector{String}
 end
 
 """
-  ``transform(df::DataFrame, col::Symbol)::Union{Nothing, DataFrame}`
+  `transform(df::DataFrame, col::Symbol)::Union{Nothing, DataFrame}`
 
 Returns a `DataFrame` structured age x year for a given feature (e.g. :Total)
 """