From 04f37ebfd10413e27ed3e9cf1496fd4c5d1b1552 Mon Sep 17 00:00:00 2001 From: Raphael Saldanha Date: Thu, 14 Mar 2024 19:52:19 +0100 Subject: [PATCH] Update documentation. --- R/check_selection.R | 5 +++-- man/check_selection.Rd | 6 +++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/R/check_selection.R b/R/check_selection.R index 4d66ee2..5e9dfd2 100644 --- a/R/check_selection.R +++ b/R/check_selection.R @@ -1,8 +1,9 @@ #' Check current selection #' +#' Check for grammar errors at the current document text selection and provide alterations suggestions if available. #' -#' @param ask_modify logical -#' @param language en-US, FR, etc +#' @param ask_modify logical. +#' @param language code like en-US, FR, etc #' #' @return nothing. #' @export diff --git a/man/check_selection.Rd b/man/check_selection.Rd index 62548e5..b82ea95 100644 --- a/man/check_selection.Rd +++ b/man/check_selection.Rd @@ -7,13 +7,13 @@ check_selection(ask_modify = TRUE, language = "auto") } \arguments{ -\item{ask_modify}{logical} +\item{ask_modify}{logical.} -\item{language}{en-US, FR, etc} +\item{language}{code like en-US, FR, etc} } \value{ nothing. } \description{ -Check current selection +Check for grammar errors at the current document text selection and provide alterations suggestions if available. }