sboysel/fredr

Documentation improvements for release

sboysel opened this issue · 3 comments

sboysel commented

Going through the documentation one last time before submitting to CRAN: verifying parameters are correct, improving function and parameter descriptions, adding usage examples, verifying consistent links and Roxygen syntax, etc.

  • Endpoint functions: Categories (Assignee: @sboysel) (#39)
  • Endpoint functions: Releases (Assignee: @DavisVaughan) (#43)
  • Endpoint functions: Series. To be consistent with the other endpoints, I was considering splitting the functions in R/fredr_series.R into separate files and documentation pages. I think the functions are distinct enough to warrant this and it seems cleaner to me. (Assignee: @sboysel) (#39)
  • Endpoint functions: Sources (Assignee: @DavisVaughan) (#45)
  • Endpoint functions: Tags (Assignee: @sboysel) (#39)
  • Misc functions: fredr_docs(), fredr_set_key(), fredr_endpoints, fredr() (Assignee: @sboysel) (#39)
  • README (#39)
  • consistent parameter descriptions (i.e. the description for limit might vary more than just the value) (Assignee: @sboysel) (#51)
  • consistent parameter ordering across functions (Assignee: @sboysel) (#51)
DavisVaughan commented

Good plan. I was going to suggest this. Im going to work on this tonight. Maybe 1 branch per endpoint would be good so we dont overlap work

sboysel commented

I've kind of been doing it in a single branch, commit-wise in #39. I'll finish up tags right now and push the work I've done. Then we can continue from there.

sboysel commented

Closing with #51. Along with #47, this good first pass over documentation.