Skip to content

Commit 4704d9c

Browse files
committed
Add missing detail to doc comments
1 parent 5c427d1 commit 4704d9c

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

src/input/process/availability.rs

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff 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.
100113
fn read_process_availabilities_from_iter<I>(
101114
iter: I,
102115
processes: &ProcessMap,

0 commit comments

Comments
 (0)