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)
diff --git a/man/KorAPConnection.Rd b/man/KorAPConnection.Rd
index 451aa24..b62aa80 100644
--- a/man/KorAPConnection.Rd
+++ b/man/KorAPConnection.Rd
@@ -2,7 +2,7 @@
% Please edit documentation in R/KorAPConnection.R
\name{KorAPConnection}
\alias{KorAPConnection}
-\title{\code{KorAPQuery} initiates a connect to some KorAP server.}
+\title{Connect to a KorAP server.}
\usage{
KorAPConnection(KorAPUrl = defaultKorAPUrl, apiVersion = "v1.0",
apiUrl = NA)
@@ -11,8 +11,11 @@
\item{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.}
}
\value{
-object that contains all necessary connection information and can be used on \code{\link{KorAPQuery}}
+object that contains all connection information and can be used with \code{\link{KorAPQuery}}
}
\description{
-\code{KorAPQuery} initiates a connect to some KorAP server.
+Connect to a KorAP server.
+}
+\note{
+Currently it is not possible to authenticate the client
}