Skip to content

Commit 98fb37b

Browse files
committed
Respond to latest round of CRAN comments
1 parent a329b82 commit 98fb37b

File tree

5 files changed

+39
-8
lines changed

5 files changed

+39
-8
lines changed

DESCRIPTION

+5-4
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ Version: 0.1.0
44
Authors@R: person("Christopher", "Baker", email = "[email protected]",
55
role = c("aut", "cre"))
66
Description: An 'RStudio' Addin for Hippie Expand (AKA Hippie Code
7-
Completion or Cyclic Expand Word). Hippie Completion searches for matching
8-
tokens within the user's current source editor file, regardless of file type.
9-
By searching only within the current source file, Hippie offers a fast way to
10-
identify and insert completions that appear around the user's cursor.
7+
Completion or Cyclic Expand Word). This type of completion searches for
8+
matching tokens within the user's current source editor file, regardless of
9+
file type. By searching only within the current source file, 'hippie' offers a
10+
fast way to identify and insert completions that appear around the user's
11+
cursor.
1112
URL: https://github.com/crew102/hippie
1213
BugReports: https://github.com/crew102/hippie/issues
1314
License: MIT + file LICENSE

R/hippie-package.R

+8-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,14 @@
33
#' Invoke Hippie Completion, either upwards or downwards. This function is meant
44
#' to be called as a shortcut.
55
#'
6-
#' @return A match token is inserted into the relevant RStudio source document
7-
#' context.
6+
#' @return Nothing. A match token is inserted into the relevant RStudio source
7+
#' document context.
88
#' @name hippie-invoke
99
#' @aliases hippie
10+
#' @examples
11+
#' \dontrun{
12+
#' # Not intended to be called directly. Rather, bind to a keyboard shortcut.
13+
#' hippie_up()
14+
#' hippie_down()
15+
#' }
1016
NULL

R/view.R

+7
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@
3636
#' straight away instead of sending it to the console first, set
3737
#' `option(hippie.pipe_to_console = FALSE)`.
3838
#'
39+
#' @return Nothing. Code is either sent to your console for evaluation or
40+
#' evaluated straight away.
41+
#' @examples
42+
#' \dontrun{
43+
#' # Not intended to be called directly. Rather, bind to a keyboard shortcut.
44+
#' invoke_view()
45+
#' }
3946
#' @export
4047
invoke_view <- function() {
4148
try(.invoke_view(), silent = TRUE)

man/hippie-invoke.Rd

+9-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/invoke_view.Rd

+10
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)