2 Checks the doc comments of publicly visible functions that
3 may panic and warns if there is no `# Panics` section.
6 Documenting the scenarios in which panicking occurs
7 can help callers who do not want to panic to avoid those situations.
10 Since the following function may panic it has a `# Panics` section in
16 /// Will panic if y is 0
17 pub fn divide_by(x: i32, y: i32) -> i32 {
19 panic!("Cannot divide by 0")