Skip to content

Commit

Permalink
Fixes various typos in the documentation (#321)
Browse files Browse the repository at this point in the history
## Description

This MR improves the documentation:

- fix typo: "For completion" with "For completeness" 
- fix typo: reset 
- fix typo: blocks 
- fix typo: remove "is"

Fixes #302, #303, #304

## Type of change

- This change requires a documentation update

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./orbit.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have run all the tests with `./orbit.sh --test` and they pass
- [ ] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
  • Loading branch information
VladimirFokow authored Mar 24, 2024
1 parent cfcabba commit a30d764
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 6 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Guidelines for modifications:
* Ritvik Singh
* Rosario Scalise
* Shafeef Omar
* Vladimir Fokow

## Acknowledgements

Expand Down
2 changes: 1 addition & 1 deletion docs/source/setup/developer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ class.
if __name__ == "__main__":
# get simulation context
simulation_context = SimulationContext()
# rest and play simulation
# reset and play simulation
simulation_context.reset()
# step simulation
simulation_context.step()
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/00_sim/launch_app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ In the case where these arguments are provided from the CLI, they will override
as we will demonstrate later in this tutorial.

These arguments can be used with any script that starts the simulation using :class:`~app.AppLauncher`,
with one exception, ``--offscreen_render``. This setting is sets the rendering pipeline to use the
with one exception, ``--offscreen_render``. This setting sets the rendering pipeline to use the
offscreen renderer. However, this setting is only compatible with the :class:`omni.isaac.orbit.sim.SimulationContext`.
It will not work with Isaac Sim's :class:`omni.isaac.core.simulation_context.SimulationContext` class.
For more information on this flag, please see the :class:`~app.AppLauncher` API documentation.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/tutorials/00_sim/spawn_prims.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ Scene designing in Omniverse is built around a software system and file format c
It allows describing 3D scenes in a hierarchical manner, similar to a file system. Since USD is a comprehensive framework,
we recommend reading the `USD documentation`_ to learn more about it.

For completion, we introduce the must know concepts of USD in this tutorial.
For completeness, we introduce the must know concepts of USD in this tutorial.

* **Primitives (Prims)**: These are the basic building block of a USD scene. They can be thought of as nodes in a scene
* **Primitives (Prims)**: These are the basic building blocks of a USD scene. They can be thought of as nodes in a scene
graph. Each node can be a mesh, a light, a camera, or a transform. It can also be a group of other prims under it.
* **Attributes**: These are the properties of a prim. They can be thought of as key-value pairs. For example, a prim can
have an attribute called ``color`` with a value of ``red``.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/03_envs/create_base_env.rst
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ started the simulation.

In this tutorial, we learned about the different managers that help define a base environment. We
include more examples of defining the base environment in the ``orbit/source/standalone/tutorials/03_envs``
directory. For completion, they can be run using the following commands:
directory. For completeness, they can be run using the following commands:

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/04_sensors/add_sensors_on_robot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ To stop the simulation, you can either close the window, or press ``Ctrl+C`` in

While in this tutorial, we went over creating and using different sensors, there are many more sensors
available in the :mod:`sensors` module. We include minimal examples of using these sensors in the
``source/standalone/tutorials/04_sensors`` directory. For completion, these scripts can be run using the
``source/standalone/tutorials/04_sensors`` directory. For completeness, these scripts can be run using the
following commands:

.. code-block:: bash
Expand Down

0 comments on commit a30d764

Please sign in to comment.