remove FIXME and (cosmicexplorer) comments #6479
Conversation
There was a problem hiding this comment.
I really like this change! I remember being confused the first time I saw FIXME, and TODO gives off a much better and welcoming tone.
What’s the reason to remove the names from TODO? The benefit of names is it makes it clear to others they don’t need to spend time on fixing it, because the person who annotated it can probably solve it much more quickly.
| @@ -217,8 +217,6 @@ def test_blows_up_on_invalid_args(self): | |||
| with self.assertRaises(TypeCheckError): | |||
| self._default_args_execute_process_request(argv=('1',), env=['foo', 'bar']) | |||
|
|
|||
| # TODO(cosmicexplorer): we should probably check that the digest info in | |||
| # ExecuteProcessRequest is valid, beyond just checking if it's a string. | |||
| with self.assertRaisesRegexp(TypeCheckError, "env"): | |||
There was a problem hiding this comment.
TODO no longer relevant?
There was a problem hiding this comment.
Yes, the ExecuteProcessRequest constructor does some type checking/coercion now.
|
Leaving a name alone isn't much context -- if there's more context than can fit in a short enough comment, an issue should be made instead (I use |
There was a problem hiding this comment.
Sounds good, particularly because we seem to prefer the issue number system instead (at Foursquare we used name system).
It may be helpful for us to start requesting PRs to open an issue anytime they add a TODO. Stu has requested this of me in the past, and would be good for us to all do the same.
Thanks again for this change!
cosmicexplorer
force-pushed
the
fix-todo-fixme
branch
from
f30b57e to
46fd3ac
Compare
Problem
FIXMEis a bit judgy for no well-defined additional meaning beyondTODO.TODO(name)syntax is (mostly) deprecated / all of the instances of its use here have enough context on their own.