Add module-level docstring to experimental features #2532
Merged
Conversation
This file contains 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
|
Merging to include it in the 3.1.0 release, these experimental docs can always be further refined. |
quaquel
reviewed
Dec 4, 2024
|
|
||
| Key components: | ||
| - Cells: Active positions that can have properties and contain agents |
There was a problem hiding this comment.
not sure what active means here. I would suggest removing it because it suggests that cells are agents which is not the case.
quaquel
reviewed
Dec 4, 2024
| - Spaces: Different cell organization patterns (grids, networks, etc.) | ||
| - PropertyLayers: Efficient property storage and manipulation | ||
|
|
||
| This is particularly useful for models where the environment plays an active role, |
There was a problem hiding this comment.
again not sure about the word active here.
22 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
This PR adds some module-level docstring to the experimental features. There is no real new information in there, just a nice write-up at the top of each file.
The first three commits contain the docstring for one module each (DEVS, Observables and Cell Space) and the fourth commit for the top level experimental init.
Docs changes only, no functional changes.
Rendered: https://mesa--2532.org.readthedocs.build/2532/apis/experimental.html