Improve mjContact documentation. Fixes #1136

PiperOrigin-RevId: 579836970 Change-Id: Ife8dd73eecdbdaacecc1e48460cf6efcf4f7b487
2023-11-06 07:27:40 -08:00
parent dafd041ad8
commit 8a5e2b19a8
3 changed files with 9 additions and 9 deletions
@@ -3871,7 +3871,7 @@ STRUCTS: Mapping[str, StructDecl] = dict([
                     inner_type=ValueType(name='mjtNum'),
                     extents=(9,),
                 ),
-                 doc='normal is in [0-2]',
+                 doc='normal is in [0-2], points from geom[0] to geom[1]',
             ),
             StructFieldDecl(
                 name='includemargin',
@@ -3931,12 +3931,12 @@ STRUCTS: Mapping[str, StructDecl] = dict([
             StructFieldDecl(
                 name='geom1',
                 type=ValueType(name='int'),
-                 doc='id of geom 1',
+                 doc='id of geom 1; deprecated, use geom[0]',
             ),
             StructFieldDecl(
                 name='geom2',
                 type=ValueType(name='int'),
-                 doc='id of geom 2',
+                 doc='id of geom 2; deprecated, use geom[1]',
             ),
             StructFieldDecl(
                 name='geom',