New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
BUG: Fix incorrect error message in vtkMRMLColorTableNode #6729
Conversation
I make this one character fix using the github web editor and it seems that the commit message shows up in a way that fails the check. I think it's actually fine to ignore unless someone knows how to fix it. |
@pieper re https://slicer.readthedocs.io/en/latest/developer_guide/style_guide.html#commits, the subject line is not capitalized because after the commit prefix it is Here it describes the commit prefix, followed by a colon, followed by a space, followed by a capitalized A-Z character.
|
This confusion was previously reported in #6692, so we could try and improve the example message to better indicate what the regex means. If enforcing the capitalization is not desired, then updating the Slicer docs about contributing to remove the note that the subject line should be capitalized. |
Wow, thanks for pointing that out @jamesobutler. I did not look at the regexp carefully. I read the error message and also the link to the Slicer documentation and never thought capitalization would be the issue. The current message is misleading IMO, since it explicitly complains about the "type" being wrong. I'll make a PR to change the message (and hope I get the commit message formatted correctly!). I'm not sure starting with a capital letter should be a hard requirement but I'll ignore that for now. If someone will provide the review approval the commit message can be fixed during the squash and merge I believe. |
Typo in error message makes debugging more difficult
e823a0a
to
6dfe09c
Compare
Typo in error message makes debugging more difficult