Add errors and panics docs

Author: cjdsellers

crates/analysis/src/analyzer.rs

@@ -194,6 +194,14 @@ impl PortfolioAnalyzer {
     }
 
     /// Calculates total `PnL` including unrealized `PnL` if provided.
+    ///
+    /// # Errors
+    ///
+    /// Returns an error if:
+    ///
+    /// - No currency is specified in a multi-currency portfolio.
+    /// - The specified currency is not found in account balances.
+    /// - The unrealized PnL currency does not match the specified currency.
     pub fn total_pnl(
         &self,
         currency: Option<&Currency>,
@@ -229,6 +237,14 @@ impl PortfolioAnalyzer {
     }
 
     /// Calculates total `PnL` as a percentage of starting balance.
+    ///
+    /// # Errors
+    ///
+    /// Returns an error if:
+    ///
+    /// - No currency is specified in a multi-currency portfolio.
+    /// - The specified currency is not found in account balances.
+    /// - The unrealized PnL currency does not match the specified currency.
     pub fn total_pnl_percentage(
         &self,
         currency: Option<&Currency>,
@@ -272,6 +288,14 @@ impl PortfolioAnalyzer {
     }
 
     /// Gets all PnL-related performance statistics.
+    ///
+    /// # Errors
+    ///
+    /// Returns an error if PnL calculations fail, for example due to:
+    ///
+    /// - No currency specified for a multi-currency portfolio.
+    /// - Unrealized PnL currency not matching the specified currency.
+    /// - Specified currency not found in account balances.
     pub fn get_performance_stats_pnls(
         &self,
         currency: Option<&Currency>,
@@ -338,6 +362,10 @@ impl PortfolioAnalyzer {
     }
 
     /// Gets formatted `PnL` statistics as strings.
+    ///
+    /// # Errors
+    ///
+    /// Returns an error if PnL statistics calculation fails.
     pub fn get_stats_pnls_formatted(
         &self,
         currency: Option<&Currency>,

crates/analysis/src/lib.rs

@@ -36,7 +36,8 @@
 #![deny(unsafe_code)]
 #![deny(nonstandard_style)]
 #![deny(missing_debug_implementations)]
-// #![deny(clippy::missing_errors_doc)]
+#![deny(clippy::missing_errors_doc)]
+#![deny(clippy::missing_panics_doc)]
 #![deny(rustdoc::broken_intra_doc_links)]
 
 pub mod analyzer;

crates/backtest/src/engine.rs

@@ -178,6 +178,14 @@ impl BacktestEngine {
         todo!("implement change_fill_model")
     }
 
+    /// Adds an instrument to the backtest engine for the specified venue.
+    ///
+    /// # Errors
+    ///
+    /// Returns an error if:
+    ///
+    /// - The instrument's associated venue has not been added via `add_venue`.
+    /// - Attempting to add a `CurrencyPair` instrument for a single-currency CASH account.
     pub fn add_instrument(&mut self, instrument: InstrumentAny) -> anyhow::Result<()> {
         let instrument_id = instrument.id();
         if let Some(exchange) = self.venues.get_mut(&instrument.id().venue) {

crates/backtest/src/exchange.rs

@@ -123,6 +123,13 @@ pub struct SimulatedExchange {
 
 impl SimulatedExchange {
     /// Creates a new [`SimulatedExchange`] instance.
+    ///
+    /// # Errors
+    ///
+    /// Returns an error if:
+    ///
+    /// - `starting_balances` is empty.
+    /// - `base_currency` is `Some` but `starting_balances` contains multiple currencies.
     #[allow(clippy::too_many_arguments)]
     pub fn new(
         venue: Venue,
@@ -213,6 +220,13 @@ impl SimulatedExchange {
         self.generate_fresh_account_state();
     }
 
+    /// Adds an instrument to the simulated exchange and initializes its matching engine.
+    ///
+    /// # Errors
+    ///
+    /// Returns an error if:
+    ///
+    /// - The exchange account type is `Cash` and the instrument is a `CryptoPerpetual` or `CryptoFuture`.
     pub fn add_instrument(&mut self, instrument: InstrumentAny) -> anyhow::Result<()> {
         check_equal(
             &instrument.id().venue,

crates/backtest/src/ffi/mod.rs

@@ -15,4 +15,6 @@
 
 //! C foreign function interface (FFI) from [cbindgen](https://github.com/mozilla/cbindgen).
 
+#![allow(unsafe_code)]
+
 pub mod engine;

crates/backtest/src/lib.rs

@@ -29,13 +29,13 @@
 //! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
 
 #![warn(rustc::all)]
+#![deny(unsafe_code)]
 #![deny(nonstandard_style)]
-// #![deny(clippy::missing_errors_doc)]
+// #![deny(missing_debug_implementations)]
+#![deny(clippy::missing_errors_doc)]
+// #![deny(clippy::missing_panics_doc)]
 #![deny(rustdoc::broken_intra_doc_links)]
 
-// Uncomment once we've added trivial `Debug` impls everywhere
-// #![warn(missing_debug_implementations)]
-
 pub mod accumulator;
 pub mod config;
 pub mod data_client;