docstrings - Githubissues

SBOHVM / RPiR

The Reproducible Programming in R course, developed by the School of Biodiversity, One Health and Veterinary Medicine at the University of Glasgow.

https://sbohvm.github.io/RPiR/

GNU General Public License v3.0

12 stars 2 forks source link

docstrings #323

Open soniamitchell opened 3 years ago

soniamitchell commented 3 years ago

Remove docstrings

If we're advocating writing packages then docstrings are only briefly useful in Series 2
If they're used in Series 3 (in packaged functions), they cause roxygen2 to generate a warning

richardreeve commented 3 years ago

I'm in two minds about this - I like being able to show documentation for functions not in packages, but it's not ideal.

soniamitchell commented 3 years ago

I wouldn’t mind if it wasn’t for the fact that series 3, 4, and the final project are package focused.

richardreeve commented 3 years ago

Yes, you're probably right. Maybe we just demonstrate it at some point, but don't ask them to use it.

soniamitchell commented 3 years ago

I think presenting multiple ways of doing something invites confusion. It's fun to learn new ways of doing things if you're already familiar with R, but as a beginner it might not be so helpful?