mirror of
https://github.com/Magnus167/msyrs.git
synced 2025-11-23 07:16:10 +00:00
Enhance documentation by adding argument descriptions to functions in historic_vol, pivots, reduce_df, and update_df modules
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
pub mod historic_vol;
|
||||
|
||||
pub mod linear_composite;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user