From 5de24197c78205ed861d837e83512549046706ec Mon Sep 17 00:00:00 2001
From: Iaroslav Omelianenko <yaric_mail@yahoo.com>
Date: Tue, 10 Oct 2023 17:28:58 +0300
Subject: [PATCH] Updated Experiment documentation

---
 R/experiment.R    | 22 ++++++++++++++++++++++
 man/Experiment.Rd | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 57 insertions(+)

diff --git a/R/experiment.R b/R/experiment.R
index 7cad5a3..9c2d38d 100644
--- a/R/experiment.R
+++ b/R/experiment.R
@@ -270,6 +270,28 @@ Experiment <- R6::R6Class(
 
     #' @description
     #' Do not call this function directly. Use `create_experiment()` or `get_experiment()` instead.
+    #'
+    #' @param experiment_key The key of the `Experiment`.
+    #' @param experiment_url The URL of the `Experiment`.
+    #' @param api_key Comet API key (can also be specified using the `COMET_API_KEY`
+    #' parameter as an environment variable or in a comet config file).
+    #' @param keep_active If `TRUE`, automatically send Comet a status update every
+    #' few seconds until the experiment is stopped to mark the experiment as active on the
+    #' Comet web dashboard.
+    #' @param log_output If `TRUE`, all standard output will automatically be sent to
+    #' the Comet servers to display as message logs for the experiment. The output will still
+    #' be shown in the console as well.
+    #' @param log_error If `TRUE`, all output from 'stderr' (which includes errors,
+    #' warnings, and messages) will be redirected to the Comet servers to display as message
+    #' logs for the experiment. Note that unlike `auto_log_output`, if this option is on then
+    #' these messages will not be shown in the console and instead they will only be logged
+    #' to the Comet experiment. This option is set to `FALSE` by default because of this
+    #' behavior.
+    #' @param dynamic If `TRUE` the Experiment was created rather than retrieved.
+    #' @param workspace_name The workspace name (can also be specified using the `COMET_WORKSPACE`
+    #' parameter as an environment variable or in a comet config file).
+    #' @param project_name The project name (can also be specified using the `COMET_PROJECT_NAME`
+    #' parameter as an environment variable or in a comet config file).
     initialize = function(experiment_key, experiment_url = NULL, api_key = NULL,
                           keep_active = FALSE, log_output = FALSE, log_error = FALSE,
                           dynamic = TRUE, workspace_name = NULL, project_name = NULL) {
diff --git a/man/Experiment.Rd b/man/Experiment.Rd
index d17a59b..198bf81 100644
--- a/man/Experiment.Rd
+++ b/man/Experiment.Rd
@@ -115,6 +115,41 @@ Do not call this function directly. Use \code{create_experiment()} or \code{get_
 )}\if{html}{\out{</div>}}
 }
 
+\subsection{Arguments}{
+\if{html}{\out{<div class="arguments">}}
+\describe{
+\item{\code{experiment_key}}{The key of the \code{Experiment}.}
+
+\item{\code{experiment_url}}{The URL of the \code{Experiment}.}
+
+\item{\code{api_key}}{Comet API key (can also be specified using the \code{COMET_API_KEY}
+parameter as an environment variable or in a comet config file).}
+
+\item{\code{keep_active}}{If \code{TRUE}, automatically send Comet a status update every
+few seconds until the experiment is stopped to mark the experiment as active on the
+Comet web dashboard.}
+
+\item{\code{log_output}}{If \code{TRUE}, all standard output will automatically be sent to
+the Comet servers to display as message logs for the experiment. The output will still
+be shown in the console as well.}
+
+\item{\code{log_error}}{If \code{TRUE}, all output from 'stderr' (which includes errors,
+warnings, and messages) will be redirected to the Comet servers to display as message
+logs for the experiment. Note that unlike \code{auto_log_output}, if this option is on then
+these messages will not be shown in the console and instead they will only be logged
+to the Comet experiment. This option is set to \code{FALSE} by default because of this
+behavior.}
+
+\item{\code{dynamic}}{If \code{TRUE} the Experiment was created rather than retrieved.}
+
+\item{\code{workspace_name}}{The workspace name (can also be specified using the \code{COMET_WORKSPACE}
+parameter as an environment variable or in a comet config file).}
+
+\item{\code{project_name}}{The project name (can also be specified using the \code{COMET_PROJECT_NAME}
+parameter as an environment variable or in a comet config file).}
+}
+\if{html}{\out{</div>}}
+}
 }
 \if{html}{\out{<hr>}}
 \if{html}{\out{<a id="method-Experiment-get_key"></a>}}