Skip to content

Commit

Permalink
update some docs to tidy up notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Tom Bowling committed Oct 25, 2023
1 parent b219a71 commit cbc8446
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 10 deletions.
2 changes: 1 addition & 1 deletion R/build_url.r
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#' @title Build URL Endpoints with Company Domain and API Version
#'
#' @description Used to generate the base API request URL. URLs will start with "https://api.bamboohr.com/api/gateway.php/{company_domain}" which forms the base URL where a query string can then be appended to make the full request URL.
#' @description Used to generate the base API request URL. URLs will start with "https://api.bamboohr.com/api/gateway.php/company_domain" which forms the base URL where a query string can then be appended to make the full request URL.
#'
#' @param company_domain The subdomain used to access BambooHR. If you access BambooHR at https://mycompany.bamboohr.com, then the company_domain is "mycompany".
#' Default value is obtained from \code{options("bambooHR.company_name")}. This can also be set in the config file using \code{config_setup("api key", "company_domain")}.
Expand Down
3 changes: 0 additions & 3 deletions R/get_request.R
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@
#' httr::content(res, "text")
#' }
#'
#' @references
#' \url{https://github.com/r-lib/httr}
#' \url{https://curl.se/libcurl/c/CURLOPT_HTTP_VERSION.html}
#'
#' @md

Expand Down
2 changes: 1 addition & 1 deletion man/bambooHR-package.Rd

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

2 changes: 1 addition & 1 deletion man/build_url.Rd

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

5 changes: 1 addition & 4 deletions man/get_request.Rd

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

0 comments on commit cbc8446

Please sign in to comment.