unseemly icon indicating copy to clipboard operation
unseemly copied to clipboard

Published 20 hours ago • verified publisher icon paulstansifer

Remove first-person singular language from comments

Open paulstansifer opened this issue 6 years ago • 1 comments

According to git grep "\bI\b" | wc, "I" is used 76 times in the codebase at the moment. Most of those should be eliminated, because it's often unclear how to edit comments written from someone else's point of view.

But I'm not sure what the best way to fix them is! A lot of them are of the form "I don't know X...", and do you just say "This code was written without understanding X"?

paulstansifer avatar May 16 '19 23:05 paulstansifer

I think it's fine to say "We don't know... " or "TODO: figure out why ..." or "Why doesn't ... ?"

paulstansifer avatar Sep 28 '19 21:09 paulstansifer