From 563fc1128c68fc2516c2a0f94af04439f3852d29 Mon Sep 17 00:00:00 2001 From: Jiri Vlasak Date: Fri, 16 Jul 2021 15:47:29 +0200 Subject: [PATCH] Rewrite drivable docstring --- incl/bcar.hh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/incl/bcar.hh b/incl/bcar.hh index 1ca3a7a..0360996 100644 --- a/incl/bcar.hh +++ b/incl/bcar.hh @@ -283,10 +283,10 @@ class BicycleCar : public virtual Pose, public virtual CarSize, public virtual CarMove { private: public: - /*! \brief Return `false` if `bc` is not achievable. + /*! \brief Return `true` if `this` can drive to `p` trivially. * - * When `false` is returned the `bc` may still be drivable, but not - * trivially, i.e. by "line segment - circle arc - line segment". + * Trivially means that `this` can drive to `p` by line segment - circle + * arc - line segment. * * \param p `PoseRange` (resp. `Pose`) to achieve. */ -- 2.39.2