Skip to content

Commit dbb66ad

Browse files
committed
Add a Panics section to component_unavailable_msg's docstring
1 parent e152dc7 commit dbb66ad

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/errors.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,10 @@ fn remove_component_msg(cs: &Component, manifest: &Manifest, toolchain: &str) ->
170170
}
171171
}
172172

173+
/// Returns a error message indicating that certain [`Component`]s are unavailable.
174+
///
175+
/// # Panics
176+
/// This function will panic when the collection of unavailable components `cs` is empty.
173177
fn component_unavailable_msg(cs: &[Component], manifest: &Manifest, toolchain: &str) -> String {
174178
let mut buf = vec![];
175179
match cs {

0 commit comments

Comments
 (0)