Add some comments to new test.

adamheins · Sep 30, 2024 · e4d9a9e · e4d9a9e
1 parent dce5cc0
commit e4d9a9e
Show file tree

Hide file tree

Showing 2 changed files with 278 additions and 0 deletions.
diff --git a/poetry.lock b/poetry.lock
diff --git a/tests/test_xacrodoc.py b/tests/test_xacrodoc.py
@@ -73,6 +73,8 @@ def test_temp_urdf_file():
 def test_resolve_packages():
     from xacrodoc.xacrodoc import _resolve_package_protocol
 
+    # spoof package paths so these all point to the same package (this one)
+    # want to test hyphens and underscores in the package names
     packages.update_package_cache(
         {
             "xacrodoc": "..",
@@ -81,11 +83,14 @@ def test_resolve_packages():
         }
     )
 
+    # some text with package protocols
     text = """
 package://xacrodoc/tests/files/threelink.urdf.xacro
 package://example-robot-data/tests/files/threelink.urdf.xacro
 package://robot_description/tests/files/threelink.urdf.xacro
 """
+
+    # all package protocols should resolve to the same absolute path
     absolute_path = Path("files/threelink.urdf.xacro").absolute().as_posix()
     expected = f"""
 {absolute_path}