We have a number of protocol validations which currently raise ValueErrors when we should be using the ProtocolValidationError type from gufe.
@atravitz also had a nice idea of creating a subclass of that error which would aways print a link to the troubleshooting guide in the docs as well as the error message, this raises another point of where the details of the validations used by protocols should live in the docs. I could see that each protocol have its own validation section outlining what it expects, but if a user hits one the torubleshooting guide might be the natural place to look. We could link back to the validation sections from the troubleshooting page if we decide they should be listed under each protocol though.
We have a number of protocol validations which currently raise
ValueErrorswhen we should be using theProtocolValidationErrortype from gufe.@atravitz also had a nice idea of creating a subclass of that error which would aways print a link to the troubleshooting guide in the docs as well as the error message, this raises another point of where the details of the validations used by protocols should live in the docs. I could see that each protocol have its own validation section outlining what it expects, but if a user hits one the torubleshooting guide might be the natural place to look. We could link back to the validation sections from the troubleshooting page if we decide they should be listed under each protocol though.