Repository navigation
Add Relocates lesson to Creating Composition Arcs - #102
Open
dillonbbailey wants to merge 2 commits into
Open
dillonbbailey wants to merge 2 commits into
dillonbbailey wants to merge 2 commits into
Conversation
OpenUSD's relocates arc was covered only by a placeholder admonition noting that LIVRPS had become LIVERPS and that content was coming soon. This adds the lesson that admonition promised and removes it. New unit under creating-composition-arcs/relocates covering what relocates are, renaming in place, reparenting across the hierarchy, removal via an empty target path, and the two constraints that cause the most confusion: only prims introduced by a composition arc can be relocated, and the source path stops being valid to author against. Exercise content follows the module's usdview-driven pattern with a simple rename example, a reparent example, and a Python exercise that authors relocates as layer metadata. Composition Basics strength ordering gains a Relocates section, and what-is-liverps gains relocates in its ordering list. The acronym is spelled LIVERPS in those two files because adding relocates to their enumerations makes the old spelling wrong; the remaining unrelated LIVRPS spellings are normalized separately. Behaviour described in the lesson was verified against usd-core 25.11. Fixes NVIDIA-Omniverse#5 Signed-off-by: Dillon Bailey <dillonb@nvidia.com> Co-Authored-By: Manuel Villanueva <118570103+Maalvi14@users.noreply.github.com> Co-Authored-By: Claude <noreply@anthropic.com>
With relocates now covered by its own lesson, the acronym is no longer in transition and the two spellings should not appear interchangeably. These files only mention the acronym in passing; none of them enumerate the arcs, so this is a terminology change with no content impact. The style guide is updated to name LIVERPS as the canonical spelling. The glossary keeps LIVRPS under "Also Known As" so the older spelling remains searchable. Signed-off-by: Dillon Bailey <dillonb@nvidia.com> Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
|
Hi Dillon, thanks for getting this through! As for the sign-off, do you need just a confirmation through here, if not you could give me access to your fork so I add a commit with my sign-off in there |
This branch has not been deployed
This file contains hidden or 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
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.
Summary
Adds the Relocates lesson that issue #5 asked for, and removes the placeholder admonition that promised it.
Relocates have been covered only by a note in
_includes/LIVRPSvLIVERPS.mdexplaining that LIVRPS had become LIVERPS and that "Learn OpenUSD will be updated soon to cover relocates." This delivers that content and retires the note.Fixes #5
What's here
New unit under
creating-composition-arcs/relocates/, following the module's existing shape (index+what-are-*+working-with-*):{code-cell}blocks; this module uses downloadable exercise content).Exercise content under
exercise_content/composition_arcs/relocates/: a rename example, a reparent example, and starter + solution scripts. These are picked up automatically by the generatedcomposition-arcs-exercise-files.zip.Supporting updates: a Relocates section in Composition Basics strength ordering, relocates added to the LIVERPS ordering list in
what-is-liverps, and theLIVRPSvLIVERPSinclude deleted along with its four include sites. A second commit normalizes the remaining bareLIVRPSspellings now that the acronym is no longer in transition.Verification
Behaviour described in the lesson was checked against usd-core 25.11 rather than written from memory. Three things that changed the content as a result:
localErrorsis empty. That footgun is called out in acautionon both pages.Also verified:
main(195 vs 195, nothing added or removed).mainexactly (130 passed / 17 failed, with the 17 being a pre-existing localusd2gltfenvironment gap, not a regression).Notes for reviewers
Attribution needs a decision. This builds on the detailed draft @Maalvi14 posted in issue #5 back in March — the structure and several passages derive from it, and the first commit credits them with a
Co-Authored-Bytrailer. They have not signed off on a commit, andCONTRIBUTING.mdrequires sign-off on all contributions. Either @Maalvi14 signs off, or I rewrite the derived passages and move the credit to an acknowledgment here. Happy to do whichever maintainers prefer.No images. Sibling lessons in this module lean heavily on diagrams and usdview screenshots; this unit is prose and code blocks only. The content stands alone, but it's visually plainer than its neighbours and would benefit from diagrams and screenshots before it ships.
🤖 Generated with Claude Code