Update Documentation for Duplicates

mitch-niche · May 15, 2019 · 467307b · 467307b
1 parent dd894d8
commit 467307b
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 19 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -12,7 +12,7 @@
 ^codecov\.yml$
 ^appveyor\.yml$
 ^_pkgdown\.yml$
-^\.package.zip$
+^package.zip$
 ^\.httr-oauth$
 ^\.httr-oauth-salesforcer$
 ^docs$

diff --git a/R/utils-org.R b/R/utils-org.R
@@ -290,13 +290,15 @@ sf_list_objects <- function(){
 #' rules on the search criteria to determine which records in other objects are duplicates.
 #' @examples
 #' \dontrun{
-#' # if insert a lead with this email address, what duplicate records exist elsewhere 
-#' # according to the Lead object's duplicate rules
-#' found_dupes <- sf_find_duplicates(search_criteria = list(Email = "bond_john@@grandhotels.com"),
+#' # use the duplicate rules associated with the Lead object on the search 
+#' # criteria (email) in order to find duplicates
+#' found_dupes <- sf_find_duplicates(search_criteria = 
+#'                                     list(Email="bond_john@@grandhotels.com"),
 #'                                   object_name = "Lead")
 #'                                   
-#' # now look across all other objects using the Contact object rules
-#' found_dupes <- sf_find_duplicates(search_criteria = list(Email = "bond_john@@grandhotels.com"),
+#' # now look for duplicates on email using the Contact object's rules
+#' found_dupes <- sf_find_duplicates(search_criteria = 
+#'                                     list(Email="bond_john@@grandhotels.com"),
 #'                                   object_name = "Contact")
 #' }
 #' @export
@@ -379,6 +381,8 @@ sf_find_duplicates <- function(search_criteria,
 #' Account object.
 #' @examples 
 #' \dontrun{
+#' # use the duplicate rules associated with the object that this record 
+#' # belongs to in order to find duplicates
 #' found_dupes <- sf_find_duplicates_by_id(sf_id = "00Q6A00000aABCnZZZ")
 #' }
 #' @export

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -70,11 +70,16 @@ reference:
     desc: Functions used for basic calls to understand the org.
     contents:
       - '`sf_user_info`'
-      - '`sf_server_timestamp`'
+      - '`sf_find_duplicates`'
+      - '`sf_find_duplicates_by_id`'
+      - '`sf_get_all_jobs_bulk`'
+      - '`sf_set_password`'
+      - '`sf_reset_password`'
       - '`sf_list_rest_api_versions`'
       - '`sf_list_resources`'
       - '`sf_list_api_limits`'
       - '`sf_list_objects`'
+      - '`sf_server_timestamp`'
   - title: Backward Compatibility with RForcecom
     desc: Functions that mirror RForcecom to ease code transitions between salesforcer and RForcecom
     contents:

diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/sf_find_duplicates.html b/docs/reference/sf_find_duplicates.html
diff --git a/docs/reference/sf_find_duplicates_by_id.html b/docs/reference/sf_find_duplicates_by_id.html
diff --git a/man/sf_find_duplicates.Rd b/man/sf_find_duplicates.Rd
diff --git a/man/sf_find_duplicates_by_id.Rd b/man/sf_find_duplicates_by_id.Rd