epiforecasts / ringbp

Simulate infectious disease transmission with contact tracing
http://epiforecasts.io/ringbp/
Other
15 stars 10 forks source link

function `@return`s #67

Open pearsonca opened 9 months ago

pearsonca commented 9 months ago

Many exported functions have no @return documentation. By eye, it seems like many of them shouldn't be exported (i.e., they are internal interface, not capability you want to provide users), but even internal functions benefit from a @return explanation.