Skip to content

Commit

Permalink
Update the docstrings for the new set/get_game_args methods
Browse files Browse the repository at this point in the history
  • Loading branch information
mwydmuch committed Nov 5, 2023
1 parent 2eb903b commit 116a952
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/api/cpp/doomGame.md
Original file line number Diff line number Diff line change
Expand Up @@ -519,9 +519,9 @@ See also:
Added in 1.3.0

Sets custom arguments that will be passed to ViZDoom process during initialization.
It is useful for changing additional game settings.
It is useful for changing additional game settings.
Use with caution, as in rare cases it may prevent the library from working properly.
Using this method is equivalent to first calling [`clearGameArgs`](#cleargameargs) and then [`addGameArgs`](#addgameargs).
Using this method is equivalent to first calling [`clearGameArgs`](#cleargameargs) and then [`addGameArgs`](#addgameargs).

Config key: `gameArgs/game_args`

Expand Down
2 changes: 1 addition & 1 deletion src/lib_python/ViZDoomMethodsDocstrings.h
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ git lo)DOCSTRING";
const char *setGameArgs = R"DOCSTRING(Sets custom arguments that will be passed to ViZDoom process during initialization.
It is useful for changing additional game settings.
Use with caution, as in rare cases it may prevent the library from working properly.
Using this method is equivalent to first calling `clearGameArgs`.)DOCSTRING";
Using this method is equivalent to first calling `clearGameArgs`.)DOCSTRING";

const char *addGameArgs = R"DOCSTRING(Adds custom arguments that will be passed to ViZDoom process during initialization.
It is useful for changing additional game settings.
Expand Down
2 changes: 1 addition & 1 deletion tests/test_game_args.py
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@


def test_game_args():

game = vzd.DoomGame()
game.set_window_visible(False)

Expand Down

0 comments on commit 116a952

Please sign in to comment.