From 0c19f3ca181cb42f96ccdfd22550f8a98e1390fd Mon Sep 17 00:00:00 2001
From: kbvernon <kenneth.b.vernon@gmail.com>
Date: Sun, 6 Oct 2024 15:59:55 -0600
Subject: [PATCH] document

---
 NAMESPACE                  |  1 +
 man/read_cargo_metadata.Rd | 39 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+)
 create mode 100644 man/read_cargo_metadata.Rd

diff --git a/NAMESPACE b/NAMESPACE
index b04fbc0d..6154edb7 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -14,6 +14,7 @@ export(document)
 export(eng_extendr)
 export(eng_extendrsrc)
 export(make_module_macro)
+export(read_cargo_metadata)
 export(register_extendr)
 export(rust_eval)
 export(rust_function)
diff --git a/man/read_cargo_metadata.Rd b/man/read_cargo_metadata.Rd
new file mode 100644
index 00000000..70d20284
--- /dev/null
+++ b/man/read_cargo_metadata.Rd
@@ -0,0 +1,39 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/read_cargo_metadata.R
+\name{read_cargo_metadata}
+\alias{read_cargo_metadata}
+\title{Retrieve metadata for packages and workspaces}
+\usage{
+read_cargo_metadata(path = ".")
+}
+\arguments{
+\item{path}{character scalar, the R package directory}
+}
+\value{
+\code{list}, including the following elements:
+\itemize{
+\item "packages"
+\item "workspace_members"
+\item "workspace_default_members"
+\item "resolve"
+\item "target_directory"
+\item "version"
+\item "workspace_root"
+\item "metadata"
+}
+}
+\description{
+Retrieve metadata for packages and workspaces
+}
+\details{
+For more details, see
+\href{https://doc.rust-lang.org/cargo/commands/cargo-metadata.html}{Cargo docs}
+for \code{cargo-metadata}. See especially "JSON Format" to get a sense of what you
+can expect to find in the returned list.
+}
+\examples{
+\dontrun{
+read_cargo_metadata()
+}
+
+}