UtrechtUniversity / workshop-computational-reproducibility

Material for the workshop 'Best Practices for Writing Reproducible Code'
https://utrechtuniversity.github.io/workshop-computational-reproducibility/
Other
8 stars 13 forks source link

correct docstring content #31

Closed nehamoopen closed 1 month ago

nehamoopen commented 3 years ago

The docstring explanation at 3:30 in the video + slides is not entirely correct. The parts with the documentation need to be inside the curly brackets.

The code should read:

multiply <- function(x,y){

#' @title Multiply two numbers
#' @description This function takes two
#' input numbers and multiplies
#' them. It returns the multiplied result.
#' @param x The first value
#' @param y The second value
#' @return The two arguments multiplied.

return(x*y)
}

?multiply 
bmkramer commented 2 years ago

This is fixed now in the slide, not the video (yet)