Update textMetadata documentation
Change-Id: I469d3c954688efd078ba3cb442a18891fa3ea36f
diff --git a/R/textMetadata.R b/R/textMetadata.R
index 8984967..a0b115a 100644
--- a/R/textMetadata.R
+++ b/R/textMetadata.R
@@ -8,6 +8,8 @@
#' @description
#' Retrieves metadata for a text, identified by its sigle (id) using the corresponding KorAP API
#' (see [Kustvakt Wiki](https://github.com/KorAP/Kustvakt/wiki/Service:-Metadata-Retrieval)).
+#' To retrieve the metadata for every text in a virtual corpus, use [corpusQuery()]
+#' with `<base/s=t>` as query, instead.
#'
#'
#' @param kco [KorAPConnection()] object (obtained e.g. from `KorAPConnection()`)
@@ -24,7 +26,7 @@
#'
#' @examples
#' \dontrun{
-#' KorAPConnection() %>% textMetadata(c("WUD17/A97/08542", "WUD17/B96/57558", "WUD17/A97/08541"))
+#' KorAPConnection() |> textMetadata(c("WUD17/A97/08542", "WUD17/B96/57558", "WUD17/A97/08541"))
#' }
#'
#' @export
diff --git a/man/textMetadata-KorAPConnection-method.Rd b/man/textMetadata-KorAPConnection-method.Rd
index 170f3e0..aadbee3 100644
--- a/man/textMetadata-KorAPConnection-method.Rd
+++ b/man/textMetadata-KorAPConnection-method.Rd
@@ -21,10 +21,12 @@
\description{
Retrieves metadata for a text, identified by its sigle (id) using the corresponding KorAP API
(see \href{https://github.com/KorAP/Kustvakt/wiki/Service:-Metadata-Retrieval}{Kustvakt Wiki}).
+To retrieve the metadata for every text in a virtual corpus, use \code{\link[=corpusQuery]{corpusQuery()}}
+with \verb{<base/s=t>} as query, instead.
}
\examples{
\dontrun{
-KorAPConnection() \%>\% textMetadata(c("WUD17/A97/08542", "WUD17/B96/57558", "WUD17/A97/08541"))
+KorAPConnection() |> textMetadata(c("WUD17/A97/08542", "WUD17/B96/57558", "WUD17/A97/08541"))
}
}