Skip to content

Commit

Permalink
Reword documentation (#87)
Browse files Browse the repository at this point in the history
* Update ip parameter

* Specify string class

* Increment version number to 0.0.0.9031
  • Loading branch information
judith-bourque authored May 10, 2023
1 parent abdcf7a commit 3b368c5
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: locateip
Title: Locate IP Addresses With 'ip-api'
Version: 0.0.0.9030
Version: 0.0.0.9031
Authors@R:
person("Judith", "Bourque", , "[email protected]", role = c("aut", "cre", "cph"))
Description: Download Internet Protocol (IP) address location and more from the 'ip-api' API.
Expand Down
20 changes: 10 additions & 10 deletions R/locate.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
#'
#' For API documentation and terms of service, see [ip-api.com](https://ip-api.com/).
#'
#' @param ip A single IPv4/IPv6 address or a domain name. If you don't supply a query the current IP address will be used.
#' @param fields Response fields to pass on to the API.
#' @param lang Response language. An ISO 639 code supported by the API. Defaults to English.
#' @param ip String. Either an IPv4 address, IPv6 address or a domain name. If NULL, will use the current IP address.
#' @param fields String. Response fields to pass on to the API.
#' @param lang String. Response language. An ISO 639 code supported by the API. Defaults to English.
#' @param ... Query parameters to pass on to the API.
#' @param tidy Logical. TRUE to return a tibble. FALSE to return a string.
#' @return A string or a tibble.
Expand Down Expand Up @@ -39,10 +39,10 @@ locate_ip <-
#'
#' For API documentation and terms of service, see [ip-api.com](https://ip-api.com/).
#'
#' @param ip A single IPv4/IPv6 address or a domain name. If you don't supply a query the current IP address will be used.
#' @param fields Response fields to pass on to the API.
#' @param ip String. Either an IPv4 address, IPv6 address or a domain name. If NULL, will use the current IP address.
#' @param fields String. Response fields to pass on to the API.
#' @param ... Query parameters to pass on to the API.
#' @param format Json, xml, csv, newline or php.
#' @param format String. Json, xml, csv, newline or php.
#' @return A response.
#'
#' @noRd
Expand Down Expand Up @@ -75,12 +75,12 @@ create_req <-
#'
#' For API documentation and terms of service, see [ip-api.com](https://ip-api.com/).
#'
#' @param ip A single IPv4/IPv6 address or a domain name. If you don't supply a query the current IP address will be used.
#' @param fields Response fields to pass on to the API.
#' @param lang Response language. An ISO 639 code supported by the API. Defaults to English.
#' @param ip String. Either an IPv4 address, IPv6 address or a domain name. If NULL, will use the current IP address.
#' @param fields String. Response fields to pass on to the API.
#' @param lang String. Response language. An ISO 639 code supported by the API. Defaults to English.
#' @param header Logical. Get field headers.
#' @param ... Query parameters to pass on to the API.
#' @param format Json, xml, csv, newline or php.
#' @param format String. Json, xml, csv, newline or php.
#' @return A response.
#'
#' @noRd
Expand Down
6 changes: 3 additions & 3 deletions man/locate_ip.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3b368c5

Please sign in to comment.