Make TODO more clear and easier to find
Opened this issue · 2 comments
Right now it is hard to identify TODO action items within the larger codebase.
All TODOs are marked exactly the same, so we should have some way to better highlight them for the user.
I tried adding emojis to do this, but I am still not happy with the result.
I think as a consumer of the tutorial (without looking at the codebase directly), the emojis are good enough in my opinion. I was able to spot them in a much easier way than just plain text.
If you are looking from the perspective of maintaining the code and differentiating between user TODOs and instructor TODOs, one way could be to add an '!' before the instructor ones. This way searching across the repo would become easier.
No, I am talking about the perspective of the consumer.
If you think they are already easy to spot that is great.
I am hoping to add more inline code documentation, and i worry that among other code comments, the TODOs will get lost.
Ideally, there would be some highlighting or changing of colors in the code editor.