Skip to content

Commit 8195ca3

Browse files
authored
Update README.md
1 parent dd8abd6 commit 8195ca3

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

grid_engine/_cell/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Cell
22

3-
The Cell class is demonstrably the most important element of `grid-engine`. It is integral in the creation and interaction of the grid. The Cell class contains information which upon arrangement with other cells, can be used to create living world. Cells should never be instantiated directly, but rather through an instance of the `grid_engine.grid.Grid` object. Instances of Cell may then be accessed through said instance.
3+
The `Cell` class is demonstrably the most important element of `grid_engine`. It is integral in the creation and interaction of the `grid`. The `Cell` class contains information which upon arrangement with other cells, can be used to create a rich and detailed environment suitable for a number of different uses. Cells should never be instantiated directly, but rather through an instance of the `grid_engine.grid.Grid` class. Instances of `Cell` may then be accessed through said `Grid` object.
44

55
## Base Properties
66

@@ -59,7 +59,9 @@ The following properties are present in cell objects relating to terrain data:
5959
## Tertiary Properties
6060

6161
The following properties are related to the values stored in the `array` property. They are prefixed with the word `entry`.
62-
Accessing and modifying these properties will be reflected in the `array` property and vice versa. Most of these properties have convenient methods for accessing and modifying them. For example, the `add_object` method can be used to add an object to the cell, thereby modifying the `entry_object` property and the `array` property.
62+
Accessing and modifying these properties will be reflected in the `array` property and vice versa. Most of these properties
63+
have convenient methods for accessing and modifying them. For example, the `add_object` method can be used to add an object
64+
to the cell, thereby modifying the `entry_object` property and the `array` property.
6365

6466
- `entry` (array): A dictionary containing the base properties of the cell. This includes the following properties:
6567
- `designation` (str)
@@ -148,4 +150,4 @@ grid = ge.grid.Grid()
148150
cell = grid.random_cell()
149151

150152
print(cell)
151-
```
153+
```

0 commit comments

Comments
 (0)