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

Documentation for the design of the DOM API #64

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

azeey
Copy link
Collaborator

@azeey azeey commented Feb 11, 2022

Resolves gazebosim/sdformat#292

Summary

Preview: http://sdformat.org/tutorials?tut=dom_api&cat=developers&branch=dom_api&repo=https%3A%2F%2Fgithub.com%2Fazeey%2Fsdf_tutorials

Checklist

  • [ ] Signed all commits for DCO
  • [ ] Added tests
  • Updated documentation (as needed)
  • [ ] Updated migration guide (as needed)
  • [ ] codecheck passed (See contributing)
  • [ ] All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
@azeey azeey requested review from nkoenig and scpeters February 11, 2022 22:23
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
the API does now allow modifying existing child objects or adding or removing
child objects.

* The frame graph is only built during `sdf::Root::Load`. Subsequent updates to
Copy link
Member

Choose a reason for hiding this comment

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

which version of SDFormat does this apply to? I know we changed things between 1.7 and 1.8

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, this statement is true only for >= libsdformat 11.0.0. I'll update it to reflect what how it works in 9.x-10.x.

Where the graphs are built depends on the version of libsdformat.

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document design of DOM objects
2 participants