search

CSHS-CWRA / CSHShydRology

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

Tidying-up the description of the functions #38

Closed MIsmlAhmed closed 3 years ago

MIsmlAhmed commented 3 years ago

Description

Updated the description of the package functions to be consistent with CRAN.

Related Issue

Example

KevinShook commented 3 years ago

Very nice. I would suggest one change. I see that you inserted the missing @return lines. That's good. However, the statement needs to be filled in with a description of the values that are being returned, e.g.

#' @return If successful, returns the values in a dataframe, consisting of the date, 
#' the value and the data code. If unsuccessful, returns the value \code{FALSE}.

Also, it would be helpful if you first create a branch in this repo, and push the changes to it first. You can then submit a pull request to merge the branch into the master.

Thanks