From 4c14d0516c3a5f1f43472080230738e922af270b Mon Sep 17 00:00:00 2001
From: Tom Elliott <tomelliottnz@gmail.com>
Date: Wed, 29 Jan 2025 08:39:14 +1300
Subject: [PATCH] Update docs

---
 man/ts_compile.Rd | 10 +++++-----
 man/ts_deploy.Rd  |  5 ++++-
 2 files changed, 9 insertions(+), 6 deletions(-)

diff --git a/man/ts_compile.Rd b/man/ts_compile.Rd
index 4a00147..091f8c1 100644
--- a/man/ts_compile.Rd
+++ b/man/ts_compile.Rd
@@ -2,22 +2,22 @@
 % Please edit documentation in R/compile.R
 \name{ts_compile}
 \alias{ts_compile}
-\title{Compile R functions to TypeScript schemas}
+\title{Compile R functions}
 \usage{
-ts_compile(f, ..., name, file)
+ts_compile(f, ..., name, filename)
 }
 \arguments{
 \item{f}{A function or file path}
 
-\item{...}{Additional arguments}
+\item{...}{Additional arguments (passed to ts_deploy)}
 
 \item{name}{The name of the function}
 
-\item{file}{The file path to write the TypeScript schema (optional). If \code{""}, the output is printed to the standard output console (see \code{cat}).}
+\item{filename}{The base file path to write the TypeScript schema and R app to (optional, uses \verb{[path of f].rserve} by default). \code{.R} and \code{.ts} file extensions are appended automatically. If \code{""}, the output is printed to the standard output console (see \code{cat}).}
 }
 \value{
 Character vector of TypeScript schema, or NULL if writing to file
 }
 \description{
-Compile R functions to TypeScript schemas
+Generates TypeScript schema for the given R function or file path. If a path, the R app is also generated.
 }
diff --git a/man/ts_deploy.Rd b/man/ts_deploy.Rd
index 49293e5..1f284a6 100644
--- a/man/ts_deploy.Rd
+++ b/man/ts_deploy.Rd
@@ -9,7 +9,8 @@ ts_deploy(
   file = sprintf("\%s.rserve.R", tools::file_path_sans_ext(f)),
   init = NULL,
   port = 6311,
-  run = c("no", "here", "background")
+  run = c("no", "here", "background"),
+  silent = FALSE
 )
 }
 \arguments{
@@ -24,6 +25,8 @@ the initialisation function}
 
 \item{run}{Whether to run the deployment script,
 takes values "no", "here", "background"}
+
+\item{silent}{Whether to print the deployment script}
 }
 \value{
 NULL, called to open an Rserve instance