KechrisLab / multiMiR

Development repository for the multiMiR database's R API
Other
19 stars 3 forks source link

Consider using Roxygen2 for documentation #1

Closed mmulvahill closed 7 years ago

mmulvahill commented 7 years ago

via Roxygen2 vignette:

Roxygen2 provides a number of advantages over writing .Rd files by hand:

  • Code and documentation are adjacent so when you modify your code, it’s easy to remember that you need to update the documentation.
  • Roxygen2 dynamically inspects the objects that it’s documenting, so it can automatically add data that you’d otherwise have to write by hand.
  • It abstracts over the differences in documenting S3 and S4 methods, generics and classes so you need to learn fewer details.
mmulvahill commented 7 years ago

Via conversation with @kechrisk low priority for now, but will reconsider this after first Bioconductor release

mmulvahill commented 7 years ago

Done