Make OpenMANIPULATOR_X workspace paths consistent by using absolute paths #1814
Conversation
Signed-off-by: HEEWONLEE7 <[email protected]>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @HEEWONLEE7, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the robustness of the documentation by standardizing the creation of ROS workspace directories. By switching from relative to absolute paths, the instructions become more resilient to the user's current working directory, preventing potential setup issues and improving clarity for new users.
Highlights
- Documentation Update: Updated the quick start guides for Humble and Jazzy ROS packages to use absolute paths when creating workspace directories.
- Path Consistency: Changed
mkdir -p colcon_ws/srctomkdir -p ~/colcon_ws/srcandmkdir -p ros2_ws/srctomkdir -p ~/ros2_ws/srcto ensure consistency and prevent issues when commands are run from unexpected locations.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request improves the robustness of the setup instructions in the documentation by using absolute paths for creating workspace directories. The changes are a good improvement. I've added a couple of suggestions to further enhance the robustness of these commands by quoting the paths. This will prevent potential errors for users who have home directory paths containing spaces or other special characters, making the documentation more reliable.
| @@ -18,7 +18,7 @@ $ sudo apt install \ | |||
| ``` | |||
|
|
|||
| ```bash | |||
| $ mkdir -p colcon_ws/src | |||
| $ mkdir -p ~/colcon_ws/src | |||
There was a problem hiding this comment.
To improve the robustness of this command, it's a good practice to quote paths that involve shell expansions like ~. This prevents errors if a user's home directory path contains spaces or other special characters.
While this might be an edge case, quoting the path makes the instructions more reliable for all users and is a good defensive practice in shell commands.
| $ mkdir -p ~/colcon_ws/src | |
| $ mkdir -p "~/colcon_ws/src" |
| @@ -18,7 +18,7 @@ This will ensure you have the latest and most compatible version for your system | |||
| #### Clone the Repository | |||
|
|
|||
| ```bash | |||
| $ mkdir -p ros2_ws/src | |||
| $ mkdir -p ~/ros2_ws/src | |||
There was a problem hiding this comment.
To make this command more robust, it's best to quote paths that use shell expansions like ~. This will prevent the command from failing if a user's home directory path contains spaces or other special characters. Quoting the path is a good defensive measure that improves the reliability of the documentation for all users.
| $ mkdir -p ~/ros2_ws/src | |
| $ mkdir -p "~/ros2_ws/src" |
|
We've decided to name the ROS workspace folder turtlebot3_ws for TurtleBot, and ros2_ws for all other cases. Could you please apply this change? |
HEEWONLEE7
changed the title
HEEWONLEE7
changed the title
This commit updates the documentation to use absolute paths (
~/colcon_ws/srcand~/ros2_ws/src) instead of relative paths (colcon_ws/srcandros2_ws/src) when creating the OpenMANIPULATOR_X workspace directory.This helps avoid potential issues when the commands are run from unexpected locations.