]> rtime.felk.cvut.cz Git - hubacji1/bcar.git/commitdiff
Update changelog, docstring
authorJiri Vlasak <hubacji1@fel.cvut.cz>
Mon, 11 May 2020 17:54:32 +0000 (19:54 +0200)
committerJiri Vlasak <hubacji1@fel.cvut.cz>
Mon, 11 May 2020 17:54:32 +0000 (19:54 +0200)
CHANGELOG.md
api/bcar.h

index 3a7e556ceb464610d0883928453ffd647f4b08c3..e50ea821eb29ba3484e063e3cbc1e3f632fb3435 100644 (file)
@@ -13,6 +13,7 @@ The format is based on [Keep a Changelog][] and this project adheres to
 
 ### Changed
 - When set up BicycleCar heading, set the interval to `[-pi, +pi]`.
+- Update drivable method to include heading.
 
 ### Fixed
 - Minimum turning radius used as curb-to-curb.
index 4c83da17029a92688b3cad12ef89a0139de02b81..551300bfcd3d459f678a8021a05d12aadd56dfa2 100644 (file)
@@ -48,9 +48,9 @@ class BicycleCar {
                 // kinematic constraints
                 /*! \brief Return `false` if `bc` is not achievable.
 
-                When `true` is returned the `bc` may still be not
-                achievable because in the current implementation,
-                heading is not considered.
+                When `false` is returned the `bc` may still be drivable,
+                because only "line segment - circle arc - line segment"
+                paths are considered in ``drivable`` method.
 
                 \param[in] bc The bicycle car to achieve.
                 */