From b0bbc66f06b1cc3dce3358865c2868193c6f184b Mon Sep 17 00:00:00 2001
From: rdb <git@rdb.name>
Date: Tue, 19 Jun 2018 00:35:04 +0200
Subject: [PATCH] bullet: document that sweep_test_closest is convex-only in
 API ref

Closes #356
---
 panda/src/bullet/bulletWorld.cxx | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/panda/src/bullet/bulletWorld.cxx b/panda/src/bullet/bulletWorld.cxx
index fce29fd2ba..38186101d6 100644
--- a/panda/src/bullet/bulletWorld.cxx
+++ b/panda/src/bullet/bulletWorld.cxx
@@ -947,7 +947,9 @@ ray_test_all(const LPoint3 &from_pos, const LPoint3 &to_pos, const CollideMask &
 }
 
 /**
- *
+ * Performs a sweep test against all other shapes that match the given group
+ * mask.  The provided shape must be a convex shape; it is an error to invoke
+ * this method using a non-convex shape.
  */
 BulletClosestHitSweepResult BulletWorld::
 sweep_test_closest(BulletShape *shape, const TransformState &from_ts, const TransformState &to_ts, const CollideMask &mask, PN_stdfloat penetration) const {