Documentation

src/logger.rs

@@ -9,6 +9,17 @@ use tracing_subscriber::registry::Registry;
 use tracing_subscriber::util::SubscriberInitExt;
 use tracing_subscriber::EnvFilter;
 
+/// Setup logging for the library
+/// 
+/// This function sets up logging for the library. It uses the `tracing` crate, and the `tracing-subscriber` crate for formatting.
+/// 
+/// The log level is defined in the configuration file, and defaults to `INFO`.
+/// 
+/// If `log_out` is specifified in teh configuration file, a log file is created with the specified name.
+/// 
+/// Additionally, if the `tui` option is set to `true`, the log messages are also written to the TUI.
+/// 
+/// If not, the log messages are written to stdout.
 pub fn setup_log(settings: &Settings, ui_tx: UnboundedSender<Comm>) {
     // Use the log level defined in configuration file, or default to info
     let log_level = settings
@@ -53,7 +64,7 @@ pub fn setup_log(settings: &Settings, ui_tx: UnboundedSender<Comm>) {
     // Define layer for TUI
     let tui_writer_closure = move || {
         TuiWriter {
-            ui_tx: ui_tx.clone(), // Ensure this clone is okay with your design (consider the lifetime of _ui_tx)
+            ui_tx: ui_tx.clone()
         }
     };
 

src/routines/settings/run.rs

@@ -4,6 +4,9 @@ use std::process::exit;
 use toml::value::Array;
 use toml::{self, Table};
 
+/// Settings used for algorithm execution
+///
+/// The user can specify the desired settings in a TOML configuration file, see `routines::settings::run` for details.
 #[derive(Deserialize, Clone, Debug)]
 pub struct Settings {
     pub computed: Computed,
@@ -17,6 +20,12 @@ pub struct Computed {
     pub fixed: Single,
 }
 
+/// The `Error` struct is used to specify the error model
+/// - `value`: the value of the error
+/// - `class`: the class of the error, can be either `additive` or `proportional`
+/// - `poly`: the polynomial coefficients of the error model
+/// 
+/// For more information see `routines::evaluation::sigma`
 #[derive(Deserialize, Clone, Debug)]
 pub struct Error {
     pub value: f64,
@@ -68,6 +77,7 @@ pub struct Config {
     pub log_level: Option<String>,
 }
 
+/// Read and parse settings from a TOML configuration file
 pub fn read(filename: String) -> Settings {
     let contents = match fs::read_to_string(&filename) {
         Ok(c) => c,