| ▲ | threethirtytwo 8 hours ago | |||||||||||||||||||
I couldn’t care less. It always pisses me off when a reviewer of my PR just flags the entire thing because of inconsistent capitalization. It’s the right correction and I always follow through but it’s also pedantic. It’s technically more correct. But it’s also not a very big deal. Actually it matters more in code for search-ability but for documentation and comments? Give me a fucking break. | ||||||||||||||||||||
| ▲ | madeofpalk 7 hours ago | parent | next [-] | |||||||||||||||||||
Isn’t being technically correct an important thing for technical documentation that aims to be technically correct? | ||||||||||||||||||||
| ||||||||||||||||||||
| ▲ | clutter55561 6 hours ago | parent | prev | next [-] | |||||||||||||||||||
I see nothing pedantic in flagging capitalisation errors, but I see loads wrong with imposing one’s sloppiness on others. | ||||||||||||||||||||
| ||||||||||||||||||||
| ▲ | windexh8er 5 hours ago | parent | prev [-] | |||||||||||||||||||
Attention to detail is important for many and is often a first touch with an end user. I agree with OP, if documentation is sloppy or inconsistent (I'm not saying the doc in question is because I haven't read it) it definitely reduces the impression that it's correct or reliable. I've skipped even trying software because of poor documentation and so the response of: > Give me a fucking break. ...seems shallow / callous. | ||||||||||||||||||||
| ||||||||||||||||||||