-
Notifications
You must be signed in to change notification settings - Fork 936
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove version specific docs #2636
base: main
Are you sure you want to change the base?
Conversation
Update version references in docs to be more generic, avoiding the need to update them with each release. Also, SolaraViz has been stable and well-tested through the Mesa 3.0.x series. Remove the experimental warnings and version-specific notes from documentation, as it is now a stable component of Mesa 3.1.
Performance benchmarks:
|
@@ -177,8 +177,6 @@ The results are returned as a list of dictionaries, which can be easily converte | |||
### Visualization | |||
Mesa now uses a new browser-based visualization system called SolaraViz. This allows for interactive, customizable visualizations of your models. | |||
|
|||
> **Note:** SolaraViz is experimental and still in active development for Mesa 3.0. While we attempt to minimize them, there might be API breaking changes between Mesa 3.0 and 3.1. There won't be breaking changes between Mesa 3.0.x patch releases. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure about this removal. Yes solara as basis is fine, but I am not convinced yet fully by the api side of things.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can't keep it experimental forever right? Maybe we need to commit to the current API and move to 4.0 if we want to change / overhaul it again.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nothing has changed fundamentally compared to where we were when releasing 3.0. So, all the reasons we had back then for keeping it experimental still stand. The passing of time alone is not a reason for making something suddenly stable.
In fact, the recent bugs we have found underline the immaturity of the code, further validating this original choice to keep it experimental.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if I fully align on the time passing statement, but in general sentiment I agree.
Shall we change the note to simply say 3.x?
Note: SolaraViz is experimental and still in active development in Mesa 3.x. While we attempt to minimize them, there might be API breaking changes in minor releases.
"""Solara based visualization for Mesa models. | ||
|
||
.. note:: | ||
SolaraViz is experimental and still in active development for Mesa 3.0. While we attempt to minimize them, there might be API breaking changes between Mesa 3.0 and 3.1. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see my earlier comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fine except the solara experimental stuff.
Update version references in docs to be more generic, avoiding the need to update them with each release.
Also, SolaraViz has been stable and well-tested through the Mesa 3.0.x series. Remove the experimental warnings and version-specific notes from documentation, as it is now a stable component of Mesa 3.1.