search

paulstansifer / unseemly

Macros have types!
http://unseemly.github.io/
MIT License
131 stars 5 forks source link

Remove first-person singular language from comments #11

Open paulstansifer opened 5 years ago

paulstansifer commented 5 years ago

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 commented 4 years ago

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