README: Document the reasons/uses of each type of example #784
Conversation
| * error: The example is expected to fail to build. | ||
| * There is only one intended use of this so far, and that is a single check that a solution without a type signature will fail to build (because CI builds with `--pedantic`). |
There was a problem hiding this comment.
Aside: This is of questionable usefulness as actionable information for us, as explained as follows:
If the error-nosig example ever successfully builds, that means there is a problem with stack --pedantic. What would we do differently in that situation?
Wait for stack to solve this problem, potentially reporting it if nobody has before?
We would have to be on our guard that other instances of --pedantic are not being respected, I suppose? So, the single error example sort of serves as a canary in the cole coal mine?
So I guess it's useful info, but given that the most likely mode of failure is out of our control, having that cause all further CI to fail would be unfortunate. My ideal would be keeping the information available but not having it break CI.
There was a problem hiding this comment.
I don't mind that we have it now that we do.
|
Should we merge this now? |
Although the README listed the three types that were proposed and
accepted in #397, it failed to
explain when we would want to use each type.
We rectify this by explaining each type.
Checks the first box (consider/document/discuss) of
#783