Skip to content

Commit

Permalink
Docs: update README for verbose tag and update TODO list
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickm663 committed Jan 25, 2024
1 parent 85847db commit 22633c2
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Once in, load `HMD`

```julia
julia> using HMD
julia> df = read_HMD("AUS", "Mx", "1x1", "username", "password");
julia> df = read_HMD("AUS", "Mx", "1x1", "username", "password"; verbose=true);
Checking inputs are valid...
Attempting initial connection...
Attempting to login...
Expand All @@ -57,7 +57,7 @@ It also supports long-form names:

```julia
julia> using HMD
julia> df = read_HMD("Australia", "Death Rates", "1x1", "username", "password");
julia> df = read_HMD("Australia", "Death Rates", "1x1", "username", "password"; verbose=true);
Checking inputs are valid...
Attempting initial connection...
Attempting to login...
Expand Down Expand Up @@ -102,12 +102,12 @@ The R package [HMDHFDplus](https://github.com/timriffe/TR1/tree/master/TR1) was
My TODO over the next while is:
- [x] Figure out why docstrings aren't showing in the documentation
- [x] Maybe refactor `src/` to make it more modular
- [ ] Complete the README
- [ ] Add tests
- [x] Complete the README
- [x] Add tests
- [x] Better error handling
- [x] Compile docs and run tests using Actions
- [ ] Think about how to handle 'secret' credentials (testing and general use)
- [ ] Better error handling
- [ ] Check for valid country x table x group combos
- [ ] Compile docs and run tests using Actions
- [ ] Make it compatible with [MortalityTables.jl](https://github.com/JuliaActuary/MortalityTables.jl)

## License
Expand Down

0 comments on commit 22633c2

Please sign in to comment.