Enhance documentation by adding argument descriptions to functions in historic_vol, pivots, reduce_df, and update_df modules

This commit is contained in:
Palash Tyagi
2025-04-07 00:22:23 +01:00
parent c10b6adfcd
commit acbe621704
5 changed files with 25 additions and 3 deletions

View File

@@ -248,7 +248,7 @@ fn get_period_indices(
}
/// Calculate historic volatility.
/// Arguments:
/// # Arguments:
/// - `df`: A Quantamental DataFrame.
/// - `xcat`: The category to calculate the historic volatility for.
/// - `cids`: A list of cross-sections. If none are provided, all cross-sections available

View File

@@ -1,3 +1,3 @@
pub mod historic_vol;
pub mod linear_composite;