R/add_squares.R

In ggoldschmidt/sentigold: What the Package Does (One Line, Title Case)

#' Title
#'
#' Description
#'
#' Details
#'
#' @author Kurt Wirth
#'
#' @param x A number.
#'
#' @param y A number.
#'
#' @return The sum of \code{x}^2 and \code{y}^2
#'
#' @examples
#'
#' add_squares(1, 2)
#'
#' add_squares(1, -2)
#'
#' @export

add_squares = function(num1, num2){

  my_sq(num1) + my_sq(num2)

}