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

Document the <topic> option for JointPositionController. #1309

Merged
merged 1 commit into from
Jan 25, 2022

Conversation

arjo129
Copy link
Contributor

@arjo129 arjo129 commented Jan 25, 2022

I discovered that the <topic> parameter has not been documented in the docstring. This mini-PR adds the docs for it.

Signed-off-by: Arjo Chakravarty [email protected]

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
I discovered that the `<topic>` parameter has not been documented in the docstring. This mini-PR adds the docs for it.

Signed-off-by: Arjo Chakravarty <[email protected]>
@arjo129 arjo129 requested a review from chapulina as a code owner January 25, 2022 02:54
@github-actions github-actions bot added the 🏯 fortress Ignition Fortress label Jan 25, 2022
@codecov
Copy link

codecov bot commented Jan 25, 2022

Codecov Report

Merging #1309 (d20a343) into ign-gazebo6 (9d36c8c) will increase coverage by 0.00%.
The diff coverage is n/a.

❗ Current head d20a343 differs from pull request most recent head 73c4553. Consider uploading reports for the commit 73c4553 to get more accurate results
Impacted file tree graph

@@             Coverage Diff              @@
##           ign-gazebo6    #1309   +/-   ##
============================================
  Coverage        62.25%   62.25%           
============================================
  Files              278      278           
  Lines            23203    23203           
============================================
+ Hits             14444    14445    +1     
+ Misses            8759     8758    -1     
Impacted Files Coverage Δ
...int_position_controller/JointPositionController.hh 100.00% <ø> (ø)
src/Server.cc 86.74% <0.00%> (+0.60%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9d36c8c...73c4553. Read the comment docs.

@arjo129 arjo129 merged commit 7a931c9 into ign-gazebo6 Jan 25, 2022
@arjo129 arjo129 deleted the arjo/docs/joint_pos_controller/topic branch January 25, 2022 07:39
@ahcorde
Copy link
Contributor

ahcorde commented Jan 25, 2022

ups, this should target ign-gazebo5. @chapulina should I cherry-pick this commit in ign-gazebo5 ? or how we backport PR ?

@chapulina chapulina added the documentation Improvements or additions to documentation label Jan 25, 2022
@chapulina
Copy link
Contributor

ups, this should target ign-gazebo5. @chapulina should I cherry-pick this commit in ign-gazebo5 ? or how we backport PR ?

Yup, cherry-picking is the way, there are some notes on the [contribution guide](https://ignitionrobotics.org/docs/all/contributing#process. You can cherry-pick just this one, or if there are other PRs in the same situation and you're willing to backport them too, feel free to bundle them in one PR (as separate commits).

@osrf-triage
Copy link

This pull request has been mentioned on Gazebo Community. There might be relevant details there:

https://community.gazebosim.org/t/new-ignition-releases-2022-03-01-citadel-edifice-fortress/1313/1

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 🏯 fortress Ignition Fortress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants