From 50ab26cee453b558141c6dfd23d3c0abeee9ecb6 Mon Sep 17 00:00:00 2001 From: Tomoya Fujita Date: Sat, 16 Mar 2024 19:42:17 -0700 Subject: [PATCH] add `Known Issues` section. Signed-off-by: Tomoya Fujita --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c3af3588..04cf2dce 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ rosdoc2 build \ ``` > [!NOTE] -> Please make sure that ROS 2 colcon workspace is NOT sourced during build. +> Please see [Known Issues](#known-issues) if failed. This command will inspect your package and run various documentation tools based on the configuration of your package. @@ -197,3 +197,9 @@ TODO ## Contributing TODO + +## Known Issues + +| Description / Error Message | Issue | Workaround | +|:---|:---:|:---| +| `No module named 'rclpy._rclpy_pybind11'` | #66 | Do not source colcon workspace. |