CSHS-CWRA / CSHShydRology

Main package
GNU Affero General Public License v3.0
35 stars 39 forks source link

Updated "rfa_ExtractAmax.R" to CRAN Standards #18

Closed JasonChiangIB closed 3 years ago

JasonChiangIB commented 3 years ago

Description

Added @return and @description to function Changed function name to ch_rfa_extractamax.R and updated all files accordingly with new name Changed variable names from . to

Fixed small typo on rfa_ExtractMMax.R

Please give my changes a quick lookover to see if I'm on the right track. If so, I will start working on other functions as well.

KevinShook commented 3 years ago

Hi Jason There are some issues with your commit

  1. The function needs to have a title line, which needs to be the first line of the function. It looks like you deleted this line. This line is separate from the @description which provides a more detailed description.
  2. Your @description and @return lines should begin with capital letters
  3. The file has been renamed, but the function hasn't. We need to change the name of the function. This means doing a search in files in Rstudio, for all of the existing function names and changing them to the new ones.

Thanks very much. K