There's a couple situations where a timestamp may be added in the past in a simulation:
Someone is making a mistake and calling Simulator.registerAction at a time that is in the past.
Someone forgot to add a call to Simulator.reset between tests.
Usually people do not often need to use the registerAction API, and if they do, they would know about how they are picking the proper timestamp. However, when people forget to call reset(), the existing error message is confusing and unhelpful.
Desired solution
Update the exception thrown when a registerAction is called with a timestamp in the past to suggest that maybe they meant to include a Simulator.reset() call.
Update the documentation/user guide as well to make it clear how to do this.
Motivation
There's a couple situations where a timestamp may be added in the past in a simulation:
Simulator.registerActionat a time that is in the past.Simulator.resetbetween tests.Usually people do not often need to use the
registerActionAPI, and if they do, they would know about how they are picking the propertimestamp. However, when people forget to callreset(), the existing error message is confusing and unhelpful.Desired solution
Update the exception thrown when a
registerActionis called with a timestamp in the past to suggest that maybe they meant to include aSimulator.reset()call.Update the documentation/user guide as well to make it clear how to do this.
Alternatives considered
No response
Additional details
No response