-
Notifications
You must be signed in to change notification settings - Fork 181
Easy SDK Python updates #1830
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Easy SDK Python updates #1830
Conversation
Signed-off-by: Hyungyu Kim <[email protected]>
Summary of ChangesHello @GyuH13, 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 significantly enhances the documentation for the Dynamixel Easy SDK by integrating a complete Python manual. It introduces new, modular API reference pages for core SDK components, providing detailed information for both Python and C++ users. Furthermore, a series of new tutorials, ranging from basic single motor control to advanced group teleoperation, have been added for both languages, making the SDK more accessible and easier to use for a broader developer audience. Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request makes significant progress in adding Python documentation for the Easy SDK and restructuring the API reference. The use of tabs for different languages and splitting content into included files improves the documentation's organization. However, there are numerous instances where C++ documentation, code examples, and type definitions have been copied into Python-specific files, leading to incorrect and misleading information for Python users. I've pointed out these copy-paste errors and other inconsistencies in the documentation. Please review these comments to ensure the accuracy of the documentation for both languages.
...software/dynamixel_easy_sdk/single_motor_control_tutorial/single_motor_tutorial_step2_cpp.md
Outdated
Show resolved
Hide resolved
_includes/en/software/dynamixel_easy_sdk/api_reference/api_reference_connector_python.md
Outdated
Show resolved
Hide resolved
...oftware/dynamixel_easy_sdk/group_motor_control_tutorial/group_motor_tutorial_step7_python.md
Outdated
Show resolved
Hide resolved
_includes/en/software/dynamixel_easy_sdk/api_reference/api_reference_python.md
Outdated
Show resolved
Hide resolved
...oftware/dynamixel_easy_sdk/group_motor_control_tutorial/group_motor_tutorial_step5_python.md
Outdated
Show resolved
Hide resolved
_includes/en/software/dynamixel_easy_sdk/api_reference/api_reference_cpp.md
Outdated
Show resolved
Hide resolved
...tware/dynamixel_easy_sdk/single_motor_control_tutorial/single_motor_tutorial_step2_python.md
Outdated
Show resolved
Hide resolved
...software/dynamixel_easy_sdk/single_motor_control_tutorial/single_motor_tutorial_step4_cpp.md
Outdated
Show resolved
Hide resolved
docs/en/software/dynamixel/dynamixel_easy_sdk/api_reference_motor.md
Outdated
Show resolved
Hide resolved
docs/en/software/dynamixel/dynamixel_easy_sdk/api_reference_motor.md
Outdated
Show resolved
Hide resolved
…ector classes; update error handling examples in group motor control tutorials.
ola31
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good
yun-goon
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good!
sunghowoo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
nhw-robotis
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work
kimtaehyeong99
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GOOD!
robotpilot
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thank you for your dedicated efforts.
Dynamixel Easy SDK python manual is added.
For check manual example, use jekyll.
ROBOTIS-GIT/DynamixelSDK#669
You can see an example of manual through below process.
Install Jekyll
It may take a few minutes the first time.
Open the URL that appeared in the terminal.