Make overflow behaviour changeable & document default

marcellussiegburg / call-alloy

MIT License

3 stars 2 forks source link

Make overflow behaviour changeable & document default #2

Closed marcellussiegburg closed 4 years ago

marcellussiegburg commented 4 years ago

Make the overflow behaviour changeable (see https://github.com/marcellussiegburg/call-alloy/blob/51af86c12d58d8e7d7b581e242b30642663bf3b9/bin/RunAlloy.java#L34)
document the default behaviour

jvoigtlaender commented 4 years ago

I guess that would simply be a Bool-typed function argument to existsInstance and getInstances?

marcellussiegburg commented 4 years ago

Yes, I guess breaking the API (and increasing a major version) by introducing a new parameter is the right move here.

jvoigtlaender commented 4 years ago

An alternative of course would be to keep the current existsInstance and getInstances functions, and introduce new versions existsInstanceWithConfig/getInstancesWithConfig that get this extra parameter, and later also potentially get further extra parameters (maybe in the form of a config record) like start seed or whatever.

Then the "default" versions existsIntance and getInstances could remain stable in the API for longer or maybe forever.