Skip to content

Commit

Permalink
fix spelling
Browse files Browse the repository at this point in the history
Signed-off-by: jparisu <[email protected]>
  • Loading branch information
jparisu committed Aug 28, 2024
1 parent 654f892 commit 96be829
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions docs/rst/modules/elements/terrain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -188,15 +188,15 @@ Example on how to create a ``MultipleDestinationTerrain``:
destinations = terrain.destinations
Sequencial Destinations Terrain
Sequential Destinations Terrain
-------------------------------

There is other class for Terrain that is called ``SequencialDestinationTerrain``.
There is other class for Terrain that is called ``SequentialDestinationTerrain``.
This class have multiple destinations, but in this case the path must pass through them in the same order as they are provided.

.. code-block:: python
from sIArena.terrain.Terrain import SequencialDestinationTerrain
from sIArena.terrain.Terrain import SequentialDestinationTerrain
The use and methods of this class are similar to ``Terrain`` ones.
Expand All @@ -206,17 +206,17 @@ It changes:
- The method ``is_complete_path`` now checks if the path passes through all the destinations in the same order as they are provided.
- To get the destinations, use the attribute ``destinations``, that is a list of ``Coordinate``.

Example on how to create a ``SequencialDestinationTerrain``:
Example on how to create a ``SequentialDestinationTerrain``:

.. code-block:: python
from sIArena.terrain.Terrain import SequencialDestinationTerrain
from sIArena.terrain.Terrain import SequentialDestinationTerrain
from sIArena.terrain.Coordinate import Coordinate
matrix = np.array(...)
destinations = [Coordinate(4,4), Coordinate(0,4)]
# It uses the top-left cell as origin by default
terrain = SequencialDestinationTerrain(matrix, destination=destinations)
terrain = SequentialDestinationTerrain(matrix, destination=destinations)
# To get the destinations of the terrain
destinations = terrain.destinations
2 changes: 1 addition & 1 deletion src/sIArena/terrain/Terrain.py
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ def get_destinations(self) -> Set[Coordinate]:



class SequencialDestinationTerrain (NoPathTerrain):
class SequentialDestinationTerrain (NoPathTerrain):
"""
This class represents a Terrain with an origin and a list of destinations that the paths must go through in order.
"""
Expand Down

0 comments on commit 96be829

Please sign in to comment.