Skip to content

Commit

Permalink
Fix pre-commit failed checks, update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mwydmuch committed Dec 12, 2023
1 parent c7aa0c5 commit f0dd95f
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 5 deletions.
3 changes: 2 additions & 1 deletion docs/api/cpp/doomGame.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,8 @@ Checks if the game is in replay mode.
| Python | `set_action(actions: list | tuple | ndarray [float]) -> None` |

Sets the player's action for the next tics.
Each value corresponds to a button previosuly specified with [`addAvailableButton`](#addavailablebutton), or [`setAvailableButtons`](#setavailablebuttons) methods,
Each value corresponds to a button previously specified
with [`addAvailableButton`](#addavailablebutton), or [`setAvailableButtons`](#setavailablebuttons) methods,
or in the configuration file (in order of appearance).


Expand Down
3 changes: 2 additions & 1 deletion docs/api/python/doomGame.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,13 @@ DoomGame is the main object of the ViZDoom library, representing a single instan
.. autofunction:: vizdoom.DoomGame.get_game_variable
```

## Game Arguments methods
## Game arguments methods

```{eval-rst}
.. autofunction:: vizdoom.DoomGame.set_game_args
.. autofunction:: vizdoom.DoomGame.add_game_args
.. autofunction:: vizdoom.DoomGame.clear_game_args
.. autofunction:: vizdoom.DoomGame.get_game_args
```

## Reward methods
Expand Down
7 changes: 5 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,13 @@
from multiprocessing import cpu_count

from setuptools import Distribution, setup
try: # for backwards compatibility with setuptools version < 65
from setuptools.command.build import build


try: # for backwards compatibility with setuptools version < 65
from setuptools.command.build import build
except ImportError:
from distutils.command.build import build

from setuptools.command.install import install
from wheel.bdist_wheel import bdist_wheel

Expand Down
3 changes: 2 additions & 1 deletion src/lib_python/ViZDoomMethodsDocstrings.h
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ See also:)DOCSTRING";
const char *isReplayingEpisode = R"DOCSTRING(Checks if the game is in replay mode.)DOCSTRING";

const char *setAction = R"DOCSTRING(Sets the player's action for the next tics.
Each value corresponds to a button previosuly specified with `addAvailableButton` methods,
Each value corresponds to a button previously specified
with `addAvailableButton` methods,
or in the configuration file (in order of appearance).)DOCSTRING";

const char *advanceAction = R"DOCSTRING(Processes the specified number of tics. If `updateState` is set,
Expand Down

0 comments on commit f0dd95f

Please sign in to comment.