explaination on #[allow(dead_code)] usage (#272)

dimforge · Sep 20, 2024 · 5a9ebff · 5a9ebff
1 parent 1cdd453
commit 5a9ebff
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/crates/parry2d/examples/common_macroquad2d.rs b/crates/parry2d/examples/common_macroquad2d.rs
@@ -10,6 +10,10 @@ use nalgebra::Point2;
 use parry2d::math::Real;
 use parry2d::shape::TriMesh;
 
+/// As this file is used as a module from other examples,
+/// rustc warns about dead code:
+/// - `main()` is needed for this file to be included in examples
+/// - For other functions, they may be "dead code" for an example, but not for others.
 #[allow(dead_code)]
 fn main() {
     println!(