VirtualPlantLab / PlantSimEngine.jl

A simulation engine for models related to plants
https://virtualplantlab.github.io/PlantSimEngine.jl/stable/
MIT License
15 stars 1 forks source link

Documentation improvements #93

Open Samuel-amap opened 6 hours ago

Samuel-amap commented 6 hours ago

Some other issues are related to documentation enhancements, but other general remarks or specific errors could be added here over time until it gets a makeover.

Samuel-amap commented 5 hours ago

A few notes :

More Multiscale examples would be worthwhile. There are several ways of declaring code before running a simulation, and more examples with MTGs could help users.

The difference between Status() and status() might need some clarification, examples make use of both without explaining the difference. Making a distinction between 'timestep state', final state, current status, etc. would also be clearer.