KentonWhite / ProjectTemplate

A template utility for R projects that provides a skeletal project.
http://projecttemplate.net
GNU General Public License v3.0
623 stars 159 forks source link

Feature request: Document internal functions #238

Closed Hugovdberg closed 6 years ago

Hugovdberg commented 6 years ago

A lot of internal functions are not documented at all. By documenting the functions it is easier to follow the thinking of other developers when reading a piece of code. Marking the functions as internal using @keywords internal allows the functions to be documented without adding an entry in the index. However, the documentation is available to both users and developers if they specifically request it. Also, tooltips in RStudio are filled with this documentation.

Hugovdberg commented 6 years ago

TODO:

Hugovdberg commented 6 years ago

Documentation was added with #243, closing this issue.