chenlin/Mujoco_WASM
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

Fixes to documentation:

Browse Source 
1. Cleaned up changelog, fixed some typos, removed nested admonitions.
2. Added missing documentation for `mjfResourceModified` function type.

PiperOrigin-RevId: 562859015
Change-Id: I34dc4f3131561cbe95be3127e6e318cc4b803a24
This commit is contained in:
Yuval Tassa
2023-09-05 12:35:41 -07:00
committed by Copybara-Service
parent 4929077211
commit ba66bd4f8b
3 changed files with 24 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/programming/extension.rst
+2 -2
View File
@@ -331,7 +331,7 @@ Resource prefix
Callbacks
There are three callbacks that a resource provider is required to implement: :ref:`open<mjfOpenResource>`,
:ref:`read<mjfReadResource>`, and :ref:`close<mjfCloseResource>`. The other two callback
:ref:`getdir<mjfGetResourceDir>` and :ref:`modified<mjfModifiedResource>` are optional. More details on these callbacks
:ref:`getdir<mjfGetResourceDir>` and :ref:`modified<mjfResourceModified>` are optional. More details on these callbacks
are given below.
Data Pointer
@@ -352,7 +352,7 @@ Resource providers work via callbacks:
- :ref:`mjfGetResourceDir<mjfGetResourceDir>`: This callback is optional and is used to extract the directory from a
resource name. For example, the resource name ``http://www.example.com/myasset.obj`` would have
``http://www.example.com/`` as its directory.
- :ref:`mjfModifiedResource<mjfModifiedResource>`: This callback is optional and is used to check if an existing
- :ref:`mjfResourceModified<mjfResourceModified>`: This callback is optional and is used to check if an existing
opened resource has been modifed from its orginal source.
.. _exProviderUsage: