Skip to content
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

API documentation common Set* features #165

Merged
merged 7 commits into from
Dec 2, 2020

Conversation

anindex
Copy link
Contributor

@anindex anindex commented Nov 14, 2020

From issue #9

@anindex anindex requested a review from mxgrey as a code owner November 14, 2020 21:01
@chapulina chapulina added the documentation Improvements or additions to documentation label Nov 16, 2020
Copy link
Contributor

@claireyywang claireyywang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some comments to be addressed, otherwise looks good to me. Good work!

/// analog to both `Link::SetWorldPose` and `Model::SetWorldPose`.
/// for FreeGroup is not well defined and difficult to implement
/// with generalized coordinates. The FreeGroup::SetWorldPose function should
/// provide an analog to both `Link::SetWorldPose` and `Model::SetWorldPose`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove the back ticks here since the previous Link::SetWorldPose didn't use them

@@ -103,6 +103,9 @@ namespace ignition
};

/////////////////////////////////////////////////
/// \brief This feature sets the generalized Joint states such as
/// Position, Velocity, Acceleration of the Joint and the applied Force to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same comment about capitalization here

@claireyywang
Copy link
Contributor

claireyywang commented Nov 19, 2020

Btw there are some code check errors in the CI need to be addressed too https://github.com/ignitionrobotics/ign-physics/pull/165/checks?check_run_id=1400840714

Signed-off-by: anindex <[email protected]>
@claireyywang claireyywang merged commit f07fe52 into gazebosim:main Dec 2, 2020
claireyywang pushed a commit that referenced this pull request Jan 7, 2021
* RemoveModelFromWorld doc
* SetBasicJointState doc
* SetJointVelocity doc
* SetShape* doc
* SetCylinderShapeProperties* doc
* SetFreeGroupWorldPose and Velocity doc
* Refine docs

Co-authored-by: anindex <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants