Opportunity for helpful error messaging?

[gdowdy3]

First, thank you very much for maintaining this repository! I only recently found this code, and I'm eager to try using it!

As I was prototyping an idea, I had some difficulty getting the solver to work. In particular, it was claiming that the problem was solved, but it was returning an optimal solution that didn't make any sense.

I was very close to concluding that the solver was garbage, but then I realized that I had a small, seemingly insignificant typo in my input dictionary: instead of 'opType', I had specified 'optype'. Changing the 't' to a 'T' caused the solver to suddenly start behaving as expected.

So, in summary, I'm not saying that there's a bug in your code. I would just like to suggest that I'm probably not the first person to make the mistake described above, and I doubt that I'll be the last. It would have been very helpful if the solver had noticed my omission of the expected keyword 'opType' and raised some sort of warning message.

That's all. 🙂