Updating doc stage.Traverse() comments regarding PrimRange
authorpixar-oss <pixar-oss@users.noreply.github.com>
Sat, 3 Feb 2024 04:04:46 +0000 (20:04 -0800)
committerpixar-oss <pixar-oss@users.noreply.github.com>
Mon, 5 Feb 2024 20:21:06 +0000 (12:21 -0800)
Fixes #222

(Internal change: 2314591)

pxr/usd/usd/stage.h

index 9a03f47522f8fc4efa99c9085d0c2870968f95fa..a1d0a991fed758d79e45e6c3b85b300d81a30cd0 100644 (file)
@@ -869,6 +869,10 @@ public:
     /// If either a pre-and-post-order traversal or a traversal rooted at a
     /// particular prim is desired, construct a UsdPrimRange directly.
     ///
+    /// You'll need to use the returned UsdPrimRange's iterator to perform 
+    /// actions such as pruning subtrees. See the "Using Usd.PrimRange in 
+    /// python" section in UsdPrimRange for more details and examples. 
+    ///
     /// This is equivalent to UsdPrimRange::Stage() . 
     USD_API
     UsdPrimRange Traverse();