Skip to content

Commit

Permalink
Fix minor documentation issues
Browse files Browse the repository at this point in the history
  • Loading branch information
StevenMMortimer committed Jun 10, 2019
1 parent 0297c34 commit e194ccf
Show file tree
Hide file tree
Showing 10 changed files with 60 additions and 60 deletions.
16 changes: 8 additions & 8 deletions R/utils-org.R
Original file line number Diff line number Diff line change
Expand Up @@ -503,11 +503,11 @@ sf_find_duplicates_by_id <- function(sf_id,
#' @param victim_ids character; one or two Salesforce Ids of records to be merged into
#' the master record. Up to three records can be merged in a single request, including
#' the master record. This limit is the same as the limit enforced by the Salesforce user
#' interface. To merge more than 3 records, successively merge records by re-running
#' this \code{\link{sf_merge}} repeatedly.
#' interface. To merge more than 3 records, successively merge records by running
#' \code{\link{sf_merge}} repeatedly.
#' @template object_name
#' @param master_fields \code{named vector}; a vector of field names and values in
#' to supersede the master record values. Otherwise, the field values on the master record
#' @param master_fields \code{named vector}; a vector of field names and values to
#' supersede the master record values. Otherwise, the field values on the master record
#' will prevail.
#' @template api_type
#' @template control
Expand Down Expand Up @@ -603,9 +603,9 @@ sf_merge <- function(master_id,
#' @importFrom purrr map_df
#' @importFrom readr type_convert cols
#' @template object_name
#' @param start \code{date} or \code{datetime}; Starting datetime of the timespan
#' @param start \code{date} or \code{datetime}; starting datetime of the timespan
#' for which to retrieve the data.
#' @param end \code{date} or \code{datetime}; Ending datetime of the timespan for
#' @param end \code{date} or \code{datetime}; ending datetime of the timespan for
#' which to retrieve the data.
#' @template verbose
#' @examples
Expand Down Expand Up @@ -673,9 +673,9 @@ sf_get_deleted <- function(object_name,
#' @importFrom dplyr tibble
#' @importFrom readr type_convert cols
#' @template object_name
#' @param start \code{date} or \code{datetime}; Starting datetime of the timespan
#' @param start \code{date} or \code{datetime}; starting datetime of the timespan
#' for which to retrieve the data.
#' @param end \code{date} or \code{datetime}; Ending datetime of the timespan for
#' @param end \code{date} or \code{datetime}; ending datetime of the timespan for
#' which to retrieve the data.
#' @template verbose
#' @examples
Expand Down
34 changes: 17 additions & 17 deletions docs/articles/getting-started.html

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

4 changes: 2 additions & 2 deletions docs/reference/sf_get_deleted.html

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

4 changes: 2 additions & 2 deletions docs/reference/sf_get_updated.html

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

8 changes: 4 additions & 4 deletions docs/reference/sf_merge.html

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

4 changes: 2 additions & 2 deletions man/sf_get_deleted.Rd

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

4 changes: 2 additions & 2 deletions man/sf_get_updated.Rd

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

8 changes: 4 additions & 4 deletions man/sf_merge.Rd

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

4 changes: 2 additions & 2 deletions vignettes/getting-started.R
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ suppressMessages(sf_auth(token = token_path, verbose = FALSE))
# it's a simple easy call to get started
# and confirm a connection to the APIs
user_info <- sf_user_info()
sprintf("User Id: %s", user_info$id)
sprintf("User Active?: %s", user_info$isActive)
sprintf("Organization Id: %s", user_info$organizationId)
sprintf("User Id: %s", user_info$userId)

## ------------------------------------------------------------------------
n <- 2
Expand Down
34 changes: 17 additions & 17 deletions vignettes/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ the information returned about the current user. It should be information about
# it's a simple easy call to get started
# and confirm a connection to the APIs
user_info <- sf_user_info()
sprintf("User Id: %s", user_info$id)
#> character(0)
sprintf("User Active?: %s", user_info$isActive)
#> character(0)
sprintf("Organization Id: %s", user_info$organizationId)
#> [1] "Organization Id: 00D6A0000003dN3UAI"
sprintf("User Id: %s", user_info$userId)
#> [1] "User Id: 0056A000000MPRjQAO"
```

### Create
Expand All @@ -75,8 +75,8 @@ created_records
#> # A tibble: 2 x 2
#> id success
#> <chr> <lgl>
#> 1 0036A00000wzh4VQAQ TRUE
#> 2 0036A00000wzh4WQAQ TRUE
#> 1 0036A00000wzkqeQAA TRUE
#> 2 0036A00000wzkqfQAA TRUE
```

### Retrieve
Expand All @@ -94,8 +94,8 @@ retrieved_records
#> # A tibble: 2 x 3
#> Id FirstName LastName
#> <chr> <chr> <chr>
#> 1 0036A00000wzh4VQAQ Test Contact-Create-1
#> 2 0036A00000wzh4WQAQ Test Contact-Create-2
#> 1 0036A00000wzkqeQAA Test Contact-Create-1
#> 2 0036A00000wzkqfQAA Test Contact-Create-2
```

### Query
Expand Down Expand Up @@ -123,8 +123,8 @@ queried_records
#> # A tibble: 2 x 4
#> Id Account FirstName LastName
#> <chr> <lgl> <chr> <chr>
#> 1 0036A00000wzh4VQAQ NA Test Contact-Create-1
#> 2 0036A00000wzh4WQAQ NA Test Contact-Create-2
#> 1 0036A00000wzkqeQAA NA Test Contact-Create-1
#> 2 0036A00000wzkqfQAA NA Test Contact-Create-2
```

### Update
Expand All @@ -149,8 +149,8 @@ updated_records
#> # A tibble: 2 x 2
#> id success
#> <chr> <lgl>
#> 1 0036A00000wzh4VQAQ TRUE
#> 2 0036A00000wzh4WQAQ TRUE
#> 1 0036A00000wzkqeQAA TRUE
#> 2 0036A00000wzkqfQAA TRUE
```

### Delete
Expand All @@ -165,8 +165,8 @@ deleted_records
#> # A tibble: 2 x 3
#> id success errors
#> <chr> <lgl> <list>
#> 1 0036A00000wzh4VQAQ TRUE <list [0]>
#> 2 0036A00000wzh4WQAQ TRUE <list [0]>
#> 1 0036A00000wzkqeQAA TRUE <list [0]>
#> 2 0036A00000wzkqfQAA TRUE <list [0]>
```

### Upsert
Expand Down Expand Up @@ -201,9 +201,9 @@ upserted_records
#> # A tibble: 3 x 3
#> created id success
#> <lgl> <chr> <lgl>
#> 1 FALSE 0036A00000wzh4XQAQ TRUE
#> 2 FALSE 0036A00000wzh4YQAQ TRUE
#> 3 TRUE 0036A00000wzh4aQAA TRUE
#> 1 FALSE 0036A00000wzkqjQAA TRUE
#> 2 FALSE 0036A00000wzkqkQAA TRUE
#> 3 TRUE 0036A00000wzkqoQAA TRUE
```


Expand Down

0 comments on commit e194ccf

Please sign in to comment.