From ccc912c3b0ae6dba0bcf5a94d9980f296a88fd46 Mon Sep 17 00:00:00 2001 From: Yuval Tassa Date: Tue, 27 May 2025 02:16:33 -0700 Subject: [PATCH] Improve docstring in `mjvGeom`, fixes #2629 PiperOrigin-RevId: 763693102 Change-Id: Icb9a3168691690ccf086adb5a20358b3952d6717 --- doc/includes/references.h | 2 +- include/mujoco/mjvisualize.h | 2 +- python/mujoco/introspect/structs.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/includes/references.h b/doc/includes/references.h index 2acf7ea6..fc9943c1 100644 --- a/doc/includes/references.h +++ b/doc/includes/references.h @@ -2815,7 +2815,7 @@ typedef struct mjvGLCamera_ mjvGLCamera; struct mjvGeom_ { // abstract geom // type info int type; // geom type (mjtGeom) - int dataid; // mesh, hfield or plane id; -1: none + int dataid; // mesh, hfield or plane id; -1: none; mesh: 2*id or 2*id+1 (hull) int objtype; // mujoco object type; mjOBJ_UNKNOWN for decor int objid; // mujoco object id; -1 for decor int category; // visual category diff --git a/include/mujoco/mjvisualize.h b/include/mujoco/mjvisualize.h index a61fe649..5903ba59 100644 --- a/include/mujoco/mjvisualize.h +++ b/include/mujoco/mjvisualize.h @@ -226,7 +226,7 @@ typedef struct mjvGLCamera_ mjvGLCamera; struct mjvGeom_ { // abstract geom // type info int type; // geom type (mjtGeom) - int dataid; // mesh, hfield or plane id; -1: none + int dataid; // mesh, hfield or plane id; -1: none; mesh: 2*id or 2*id+1 (hull) int objtype; // mujoco object type; mjOBJ_UNKNOWN for decor int objid; // mujoco object id; -1 for decor int category; // visual category diff --git a/python/mujoco/introspect/structs.py b/python/mujoco/introspect/structs.py index 8ab28046..283a158a 100644 --- a/python/mujoco/introspect/structs.py +++ b/python/mujoco/introspect/structs.py @@ -6567,7 +6567,7 @@ STRUCTS: Mapping[str, StructDecl] = dict([ StructFieldDecl( name='dataid', type=ValueType(name='int'), - doc='mesh, hfield or plane id; -1: none', + doc='mesh, hfield or plane id; -1: none; mesh: 2*id or 2*id+1 (hull)', # pylint: disable=line-too-long ), StructFieldDecl( name='objtype',