diff --git a/.Rbuildignore b/.Rbuildignore index 56a192e..8c89bd5 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -11,3 +11,4 @@ ^docs$ ^pkgdown$ ^cran-comments\.md$ +^CRAN-SUBMISSION$ diff --git a/DESCRIPTION b/DESCRIPTION index 6766ee8..6067a3c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,5 +1,5 @@ Package: adaR -Title: A Fast WHATWG Compliant URL Parser +Title: A Fast 'WHATWG' Compliant URL Parser Version: 0.2.0 Authors@R: c(person("David", "Schoch", , "david@schochastics.net", role = c("aut", "cre"), @@ -9,7 +9,7 @@ Authors@R: person("Yagiz", "Nizipli", role = c("ctb", "cph"),comment = "author of ada-url : "), person("Daniel", "Lemire", role = c("ctb", "cph"),comment = "author of ada-url : ") ) -Description: A wrapper for ada-url, a WHATWG-compliant and fast URL parser written in modern C++. Also contains auxiliary functions such as a public suffix extractor. +Description: A wrapper for 'ada-url', a 'WHATWG' compliant and fast URL parser written in modern 'C++'. Also contains auxiliary functions such as a public suffix extractor. URL: https://schochastics.github.io/adaR/, https://github.com/schochastics/adaR BugReports: https://github.com/schochastics/adaR/issues License: MIT + file LICENSE diff --git a/R/parse.R b/R/parse.R index ab498c7..2949f3a 100644 --- a/R/parse.R +++ b/R/parse.R @@ -35,6 +35,7 @@ ada_url_parse <- function(url, decode = TRUE) { #' Similar to [utils::URLdecode] #' #' @param url a character vector +#' @return precent decoded URLs as character vector #' @export #' @examples #' url_decode2("Hello%20World") diff --git a/R/psl.R b/R/psl.R index 45d8a9f..0889db4 100644 --- a/R/psl.R +++ b/R/psl.R @@ -2,6 +2,7 @@ #' #' @param domains character. vector of domains or hostnames #' @export +#' @return public suffixes of domains as character vector #' @examples #' public_suffix("http://example.com") #' diff --git a/cran-comments.md b/cran-comments.md index 38296fb..98dba2e 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,4 +1,22 @@ -## Initial Submission +## Resubmission of initial submission + +Please always write package names, software names and API (application +programming interface) names in single quotes in title and description. +e.g: --> 'WHATWG', 'C++', 'ada-url' +Please note that package names are case sensitive. + +-> fixed + +If there are references describing the methods in your package, please +add these in the description field of your DESCRIPTION file in the form + +-> there are no official or citable references describing the method + +Missing Rd-tags: + public_suffix.Rd: \value + url_decode2.Rd: \value + +-> fixed # Test environments * ubuntu 22.04, R 4.3.1 diff --git a/man/public_suffix.Rd b/man/public_suffix.Rd index f1229f5..b5bd2d5 100644 --- a/man/public_suffix.Rd +++ b/man/public_suffix.Rd @@ -9,6 +9,9 @@ public_suffix(domains) \arguments{ \item{domains}{character. vector of domains or hostnames} } +\value{ +public suffixes of domains as character vector +} \description{ Extract the public suffix from a vector of domains or hostnames } diff --git a/man/url_decode2.Rd b/man/url_decode2.Rd index 4db5a13..1b28316 100644 --- a/man/url_decode2.Rd +++ b/man/url_decode2.Rd @@ -9,6 +9,9 @@ url_decode2(url) \arguments{ \item{url}{a character vector} } +\value{ +precent decoded URLs as character vector +} \description{ Similar to \link[utils:URLencode]{utils::URLdecode} }