KorAPConnection: update documentation
Change-Id: I82165545b92b297db28bb9d1a9312a420b4ffc3c
diff --git a/R/KorAPConnection.R b/R/KorAPConnection.R
index 469f228..4652927 100644
--- a/R/KorAPConnection.R
+++ b/R/KorAPConnection.R
@@ -3,9 +3,12 @@
defaultKorAPUrl <- "https://korap.ids-mannheim.de/"
-#' \code{KorAPQuery} initiates a connect to some KorAP server.
+#' Connect to a KorAP server.
#' @param KorAPUrl instead of providing the query and vc string parameters, you can also simply copy a KorAP query URL from your browser and use it here (and in \code{KorAPConnection}) to provide all necessary information for the query.
-#' @return object that contains all necessary connection information and can be used on \code{\link{KorAPQuery}}
+#' @return object that contains all connection information and can be used with \code{\link{KorAPQuery}}
+#'
+#' @note Currently it is not possible to authenticate the client
+#'
#' @export
KorAPConnection <- function(KorAPUrl=defaultKorAPUrl, apiVersion='v1.0', apiUrl = NA) {
m <-regexpr("https?://[^?]+", KorAPUrl, perl = TRUE)