Fix docs build

appliedAI-Initiative · Mar 1, 2024 · 9a8e96e · 9a8e96e
1 parent 6b2ae9c
commit 9a8e96e
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 129 deletions.
diff --git a/docs/02_notebooks/01_library_example.ipynb b/docs/02_notebooks/01_library_example.ipynb
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
@@ -17,4 +17,21 @@ pydocstyle
 submodules
 subpackages
 utils
-webpage
+webpage
+util
+bbox
+pos
+img
+yx
+hw
+param
+urandom
+envs
+labelmap
+labelmaps
+generalised
+unnormalizes
+unnormalize
+unnormalized
+args
+dev
diff --git a/src/armscan_env/envs/base.py b/src/armscan_env/envs/base.py
@@ -217,6 +217,7 @@ def reset(self, **kwargs: Any) -> tuple[TObs, dict[str, Any]]:
         return self.cur_observation, self.get_info_dict()
 
     def step(self, action: TAction) -> tuple[TObs, float, bool, bool, dict[str, Any]]:
+        """Step through the environment to navigate to the next state."""
         self._go_to_next_state(action)
         self._cur_episode_len += 1
         assert self.cur_observation is not None

diff --git a/src/armscan_env/envs/env_wrappers/__init__.py b/src/armscan_env/envs/env_wrappers/__init__.py