Sometimes when ending a simulation, you may want to wait for it to actually end. This PR makes Simulator.endSimulation return a Future<void> which is the same as Simulator.simulationEnded, saving some time and lines.
Related Issue(s)
N/A
Testing
Added new test
Backwards-compatibility
Is this a breaking change that will not be backwards-compatible? If yes, how so?
Probably not, but you may get a lint warning depending on settings for unawaited futures, or you may get some behavior changes if you have things that behave differently on Futures vs voids.
Documentation
Does the change require any updates to documentation? If so, where? Are they included?
Description & Motivation
Sometimes when ending a simulation, you may want to wait for it to actually end. This PR makes
Simulator.endSimulationreturn aFuture<void>which is the same asSimulator.simulationEnded, saving some time and lines.Related Issue(s)
N/A
Testing
Added new test
Backwards-compatibility
Probably not, but you may get a lint warning depending on settings for unawaited futures, or you may get some behavior changes if you have things that behave differently on Futures vs voids.
Documentation
No