Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jeguzzi committed Nov 29, 2024
1 parent 3f0f2fe commit 9d04727
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
8 changes: 3 additions & 5 deletions docs/guides/validate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,18 @@ Packages :py:mod:`navground.core` and :py:mod:`navground.sim` have type hints.

To check the packages themselves, you can run

.. command-output:: mypy -p navground.core --namespace-packages --ignore-missing-imports
.. command-output:: mypy -p navground.core --strict

and

.. command-output:: mypy -p navground.sim --namespace-packages --ignore-missing-imports
.. command-output:: mypy -p navground.core --strict


.. note:: ``--ignore-missing-imports`` silences errors from third party packages missing type hints.

To check your package, you can run

.. code-block:: console
$ mypy <path> --ignore-missing-imports
$ mypy <path>
YAML
Expand Down
2 changes: 1 addition & 1 deletion navground_sim_py/navground/sim/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ def bar_update(run: ExperimentalRun) -> None:


Experiment.setup_tqdm = setup_tqdm # type: ignore[method-assign]
Experiment.run_mp = run_mp # type: ignore[assignment]
Experiment.run_mp = run_mp # type: ignore[method-assign]

# isort: stop
from .recorded_experiment import RecordedExperiment, RecordedExperimentalRun # noqa: E402
Expand Down

0 comments on commit 9d04727

Please sign in to comment.