Documentation should also explain what happens with bad args #2679
JohnAAbbott
started this conversation in
General
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
I am considering using the function
solve_non_negative
. The documentation (from inside a running Julia/Oscar session) says:So what happens if I call the function with an input which violates the assumption? Why is this not documented?
Of course, I could just try it, but, apart from costing me time, it does not tell what the function will do tomorrow or the day after. If the doc guaranteed that the function throws an exception when there are infinitely many solutions then I can write code based on this guarantee.
The same questions arise for every function which "makes assumptions" about it inputs.
Beta Was this translation helpful? Give feedback.
All reactions