File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -74,6 +74,7 @@ enum LimitType {
7474/// * `model_dir` - Folder containing model configuration files
7575/// * `processes` - Map of processes
7676/// * `time_slice_info` - Information about seasons and times of day
77+ /// * `base_year` - First milestone year of simulation
7778///
7879/// # Returns
7980///
@@ -96,7 +97,19 @@ pub fn read_process_availabilities(
9697 . with_context ( || input_err_msg ( & file_path) )
9798}
9899
99- /// Process raw process availabilities input data into [`ProcessActivityLimitsMap`]s
100+ /// Process raw process availabilities input data into [`ProcessActivityLimitsMap`]s.
101+ ///
102+ /// # Arguments
103+ ///
104+ /// * `iter` - Iterator of raw process availability records
105+ /// * `processes` - Map of processes
106+ /// * `time_slice_info` - Information about seasons and times of day
107+ /// * `base_year` - First milestone year of simulation
108+ ///
109+ /// # Returns
110+ ///
111+ /// A [`HashMap`] with process IDs as the keys and [`ProcessActivityLimitsMap`]s as the values or an
112+ /// error.
100113fn read_process_availabilities_from_iter < I > (
101114 iter : I ,
102115 processes : & ProcessMap ,
You can’t perform that action at this time.
0 commit comments