space: Document empties property #1888
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Document the empties property in the Mesa Space module for the different Grids. I might have overdone it a little, but that's in the spirit of PEP 20: Explicit is better than implicit.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1888 +/- ##
=======================================
Coverage 77.10% 77.10%
=======================================
Files 15 15
Lines 974 974
Branches 214 214
=======================================
Hits 751 751
Misses 195 195
Partials 28 28 ☔ View full report in Codecov by Sentry. |
rht
reviewed
Nov 27, 2023
mesa/space.py
Outdated
| @@ -526,6 +535,9 @@ class MultiGrid(_Grid): | |||
| bottom-left and [width-1, height-1] is the top-right. If a grid is | |||
| toroidal, the top and bottom, and left and right, edges wrap to each other. | |||
|
|
|||
| Unlike SingleGrid, MultiGrid does not inherently track empty cells due to | |||
There was a problem hiding this comment.
empties are tracked in MultiGrid. MultiGrid inherits from _Grid, which defines the empties property.
In [1]: import mesa
g =
In [2]: g = mesa.space.MultiGrid(5,5,False)
In [3]: g.empties
Out[3]:
{(0, 0),
(0, 1),
...
There was a problem hiding this comment.
You're right, will update that (also in HexMulti)
rht
approved these changes
Nov 28, 2023
|
Merged, thank you. |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document the empties property in the Mesa Space module for the different Grids.
I might have overdone it a little, but that's in the spirit of PEP 20:
Only documentation changes, no functional ones.