Skip to content

Commit c32fd35

Browse files
committed
Improve documentation.
1 parent a952d5d commit c32fd35

File tree

8 files changed

+30
-12
lines changed

8 files changed

+30
-12
lines changed

R/cache_aws_s3.r

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
#' @name cache_aws_s3
2-
#' @title Initiate an Amazon Web Services Cache
2+
#' @title Amazon Web Services S3 Cache
3+
#' @description
4+
#' Initiate an Amazon Web Services Cache
35
#' @usage
46
#'
57
#' Sys.setenv("AWS_ACCESS_KEY_ID" = "<access key>",
68
#' "AWS_SECRET_ACCESS_KEY" = "<access secret>")
79
#'
8-
#' cache_aws_s3("unique-bucket-name")
10+
#' cache_aws_s3(cache_name = "unique-bucket-name")
911
#'
1012
#' @param cache_name Bucket name for storing cache files.
1113
#' Use R to cache items.

R/cache_datastore.r

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
#' @name cache_datastore
2-
#' @title Initiate a datastore cache.
2+
#' @title Google Datastore Cache
3+
#' @description Initiate a Google Datastore cache.
34
#' @param project Google Cloud project
45
#' @param cache_name datastore kind to use for storing cache entities.
56
#' @usage

R/cache_filesystem.r

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
#' @name cache_filesystem
2-
#' @title Initiate a filesystem cache.
2+
#' @title Filesystem Cache
3+
#' @description
4+
#' Initiate a filesystem cache.
35
#' @usage
46
#' cache_filesystem stores cached items within a directory. It can be used with
57
#' Dropbox or Google Drive to allow for cache access from multiple computers.

R/cache_local.r

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
#' @name cache_local
2-
#' @title Initiate an in memory cache.
2+
#' @title In Memory Cache
3+
#' @description Initiate an in memory cache.
34
#'
45
#' cache_local() stores cached items in memory.
56
#'

man/cache_aws_s3.Rd

Lines changed: 5 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/cache_datastore.Rd

Lines changed: 4 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/cache_filesystem.Rd

Lines changed: 4 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/cache_local.Rd

Lines changed: 6 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)