Unverified Commit 18c4718d authored by Louis LE LAY's avatar Louis LE LAY Committed by GitHub

Updates help text and docs to reflect pytest usage (#2638)

# Description

This updates the help output of the main script (isaaclab.sh/bat --help)
and the docs to reflect the switch from unittest to pytest for running
unit tests.

## Type of change

- This change requires a documentation update

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.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
- [N/A] 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
parent c984604c
...@@ -416,7 +416,7 @@ We summarize the key points below: ...@@ -416,7 +416,7 @@ We summarize the key points below:
Unit Testing Unit Testing
^^^^^^^^^^^^ ^^^^^^^^^^^^
We use `unittest <https://docs.python.org/3/library/unittest.html>`__ for unit testing. We use `pytest <https://docs.pytest.org>`__ for unit testing.
Good tests not only cover the basic functionality of the code but also the edge cases. Good tests not only cover the basic functionality of the code but also the edge cases.
They should be able to catch regressions and ensure that the code is working as expected. They should be able to catch regressions and ensure that the code is working as expected.
Please make sure that you add tests for your changes. Please make sure that you add tests for your changes.
......
...@@ -211,7 +211,7 @@ Clone the Isaac Lab repository into your workspace: ...@@ -211,7 +211,7 @@ Clone the Isaac Lab repository into your workspace:
-f, --format Run pre-commit to format the code and check lints. -f, --format Run pre-commit to format the code and check lints.
-p, --python Run the python executable provided by Isaac Sim or virtual environment (if active). -p, --python Run the python executable provided by Isaac Sim or virtual environment (if active).
-s, --sim Run the simulator executable (isaac-sim.sh) provided by Isaac Sim. -s, --sim Run the simulator executable (isaac-sim.sh) provided by Isaac Sim.
-t, --test Run all python unittest tests. -t, --test Run all python pytest tests.
-o, --docker Run the docker container helper script (docker/container.sh). -o, --docker Run the docker container helper script (docker/container.sh).
-v, --vscode Generate the VSCode settings file from template. -v, --vscode Generate the VSCode settings file from template.
-d, --docs Build the documentation from source using sphinx. -d, --docs Build the documentation from source using sphinx.
...@@ -233,7 +233,7 @@ Clone the Isaac Lab repository into your workspace: ...@@ -233,7 +233,7 @@ Clone the Isaac Lab repository into your workspace:
-f, --format Run pre-commit to format the code and check lints. -f, --format Run pre-commit to format the code and check lints.
-p, --python Run the python executable provided by Isaac Sim or virtual environment (if active). -p, --python Run the python executable provided by Isaac Sim or virtual environment (if active).
-s, --sim Run the simulator executable (isaac-sim.bat) provided by Isaac Sim. -s, --sim Run the simulator executable (isaac-sim.bat) provided by Isaac Sim.
-t, --test Run all python unittest tests. -t, --test Run all python pytest tests.
-v, --vscode Generate the VSCode settings file from template. -v, --vscode Generate the VSCode settings file from template.
-d, --docs Build the documentation from source using sphinx. -d, --docs Build the documentation from source using sphinx.
-n, --new Create a new external project or internal task from template. -n, --new Create a new external project or internal task from template.
......
...@@ -219,7 +219,7 @@ Clone the Isaac Lab repository into your workspace: ...@@ -219,7 +219,7 @@ Clone the Isaac Lab repository into your workspace:
-f, --format Run pre-commit to format the code and check lints. -f, --format Run pre-commit to format the code and check lints.
-p, --python Run the python executable provided by Isaac Sim or virtual environment (if active). -p, --python Run the python executable provided by Isaac Sim or virtual environment (if active).
-s, --sim Run the simulator executable (isaac-sim.sh) provided by Isaac Sim. -s, --sim Run the simulator executable (isaac-sim.sh) provided by Isaac Sim.
-t, --test Run all python unittest tests. -t, --test Run all python pytest tests.
-o, --docker Run the docker container helper script (docker/container.sh). -o, --docker Run the docker container helper script (docker/container.sh).
-v, --vscode Generate the VSCode settings file from template. -v, --vscode Generate the VSCode settings file from template.
-d, --docs Build the documentation from source using sphinx. -d, --docs Build the documentation from source using sphinx.
...@@ -241,7 +241,7 @@ Clone the Isaac Lab repository into your workspace: ...@@ -241,7 +241,7 @@ Clone the Isaac Lab repository into your workspace:
-f, --format Run pre-commit to format the code and check lints. -f, --format Run pre-commit to format the code and check lints.
-p, --python Run the python executable provided by Isaac Sim or virtual environment (if active). -p, --python Run the python executable provided by Isaac Sim or virtual environment (if active).
-s, --sim Run the simulator executable (isaac-sim.bat) provided by Isaac Sim. -s, --sim Run the simulator executable (isaac-sim.bat) provided by Isaac Sim.
-t, --test Run all python unittest tests. -t, --test Run all python pytest tests.
-v, --vscode Generate the VSCode settings file from template. -v, --vscode Generate the VSCode settings file from template.
-d, --docs Build the documentation from source using sphinx. -d, --docs Build the documentation from source using sphinx.
-n, --new Create a new external project or internal task from template. -n, --new Create a new external project or internal task from template.
......
...@@ -241,7 +241,7 @@ echo -i, --install [LIB] Install the extensions inside Isaac Lab and learni ...@@ -241,7 +241,7 @@ echo -i, --install [LIB] Install the extensions inside Isaac Lab and learni
echo -f, --format Run pre-commit to format the code and check lints. echo -f, --format Run pre-commit to format the code and check lints.
echo -p, --python Run the python executable (python.bat) provided by Isaac Sim. echo -p, --python Run the python executable (python.bat) provided by Isaac Sim.
echo -s, --sim Run the simulator executable (isaac-sim.bat) provided by Isaac Sim. echo -s, --sim Run the simulator executable (isaac-sim.bat) provided by Isaac Sim.
echo -t, --test Run all python unittest tests. echo -t, --test Run all python pytest tests.
echo -v, --vscode Generate the VSCode settings file from template. echo -v, --vscode Generate the VSCode settings file from template.
echo -d, --docs Build the documentation from source using sphinx. echo -d, --docs Build the documentation from source using sphinx.
echo -n, --new Create a new external project or internal task from template. echo -n, --new Create a new external project or internal task from template.
......
...@@ -247,7 +247,7 @@ print_help () { ...@@ -247,7 +247,7 @@ print_help () {
echo -e "\t-f, --format Run pre-commit to format the code and check lints." echo -e "\t-f, --format Run pre-commit to format the code and check lints."
echo -e "\t-p, --python Run the python executable provided by Isaac Sim or virtual environment (if active)." echo -e "\t-p, --python Run the python executable provided by Isaac Sim or virtual environment (if active)."
echo -e "\t-s, --sim Run the simulator executable (isaac-sim.sh) provided by Isaac Sim." echo -e "\t-s, --sim Run the simulator executable (isaac-sim.sh) provided by Isaac Sim."
echo -e "\t-t, --test Run all python unittest tests." echo -e "\t-t, --test Run all python pytest tests."
echo -e "\t-o, --docker Run the docker container helper script (docker/container.sh)." echo -e "\t-o, --docker Run the docker container helper script (docker/container.sh)."
echo -e "\t-v, --vscode Generate the VSCode settings file from template." echo -e "\t-v, --vscode Generate the VSCode settings file from template."
echo -e "\t-d, --docs Build the documentation from source using sphinx." echo -e "\t-d, --docs Build the documentation from source using sphinx."
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment