Exposed all existing documentation in Articulated_agents, articulated_agent_controllers, core, and config modules #1736
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
facebook-github-bot
added
the
CLA Signed
mosra
reviewed
Jan 5, 2024
| resets to 0. | ||
| :property ee_offset: The 3D offset from the end-effector link to the true | ||
| end-effector position. | ||
| :property arm_init_params: The starting joint angles of the arm. If None, resets to 0. |
There was a problem hiding this comment.
Wrapping the docstring like it was before shouldn't cause any problems for the doc generator. The successive lines just need to be indented respective to the first :property : line.
| @@ -29,7 +30,7 @@ class Motion: | |||
| :param joints_quat_array: num_poses x num_joints x 4 array, containing the join orientations | |||
| :param transform_array: num_poses x 4 x 4 array, containing the root transform | |||
| :param displacement: on each pose, how much forward displacement was there? | |||
| Used to measure how many poses we should advance to move a cerain amount | |||
| Used to measure how many poses we should advance to move a cerain amount | |||
There was a problem hiding this comment.
I.e., this will most probably cause a problem -- it should be indented like before, or on a single line.
…into labdocsv1 Addition of HITL module
… core, and config modules
henrysamer
changed the title
add minimal.py
…at-lab into labdocsv1 include circleci fix
aclegg3
approved these changes
Jan 17, 2024
| :param joints_quat: list or array of num_joints * 4 elements, with the rotation quaternions | ||
| :param root_transform: Matrix4 with the root transform. | ||
| :param root_transform: Matrix4 with the root trasnform. |
There was a problem hiding this comment.
Suggested change
| :param root_transform: Matrix4 with the root trasnform. | |
| :param root_transform: Matrix4 with the root transform. |
dannymcy
pushed a commit
to dannymcy/habitat-lab
that referenced
this pull request
Jul 8, 2024
…_agent_controllers, core, and config modules (facebookresearch#1736) * Update completed class/function documentation in labdocsv1 * pre-commit passed * Exposed class modules * Exposed methods in Articulated_agents, articulated_agent_controllers, core, and config modules * fix duplicate param causing doc build failure --------- Co-authored-by: “Sam <“henrysamer@meta.com”> Co-authored-by: aclegg3 <alexanderwclegg@gmail.com>
HHYHRHY
pushed a commit
to SgtVincent/EMOS
that referenced
this pull request
Aug 31, 2024
…_agent_controllers, core, and config modules (facebookresearch#1736) * Update completed class/function documentation in labdocsv1 * pre-commit passed * Exposed class modules * Exposed methods in Articulated_agents, articulated_agent_controllers, core, and config modules * fix duplicate param causing doc build failure --------- Co-authored-by: “Sam <“henrysamer@meta.com”> Co-authored-by: aclegg3 <alexanderwclegg@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
Improve documentation coverage and quality in habitat-lab. Add type hints to functions and classes to enhance clarity, facilitate static analysis, and assist in bug detection.
How Has This Been Tested
Changes tested through local build verification and validation using tools like mypy.
Types of changes
Checklist