3 ms·
The subject line should be 'why': Fix 500 due to syntax error accessing /users the body can summarise and expand on (..if you know what I mean) the diff a
by OJFord 4y ago
The subject line should be 'why':
Fix 500 due to syntax error accessing /users
the body can summarise and expand on (..if you know what I mean) the diff as well as explaining why:
Due to <arcane language reason> in this case <syntax> was
interpreted as a baz, when clearly the author in <blame commit>
intended foo, which would return the response with bars here
as expected.
This commit fixes the issue by adding an explicit semicolon,
thus forcing the foo interpretation.
That's probably overkill for a simple syntax error (unless it really is that arcane in which case it might be a bit of a teaching moment/object lesson).
Compare:
Add semicolon
[no body]
- scotty79 4y agoFirst version sounds passive-aggresive.
- OJFord 4y agoThe exact wording really isn't the point, I see what you're saying but it's not what I intended - that's just the lack of a concrete example (something actually arcane and counter-intuitive) making it more difficult. I was imagining writing it from the perspective of 'this took a good bit of looking into why it didn't work like it looks like it should have'.
- scotty79 4y agoI'm not sure if it's accidental. Too much detail just sounds as if you not only fixed something but also lodged a formal complaint against whoever touched that place first. Technically it's good because it's very informative and probably noone will read it unless you, yourself made a mistake and the thing you fixed still doesn't work for some cases. Just sounds weird. But I'd still prefer it to "Added semicolon" for a commit diff that adds semicolon and nothing else. At minimum I'd like to see a link to a ticket that this change is supposed to solve.