Hi everyone,
While reviewing the current frontend docs I noticed that several TODOs comments from the source code are being rendered directly on the live site.
Is it the community’s preference to keep these TODOs visible as a way to invite new contributors to tackle those specific tasks?
I didn’t recognize the term “current frontend docs” and had to make guesses. My guess led me to the Jenkins documentation site and I found the specific page you’re referencing:
I think it is good to retain the TODO because of the text that immediately follows the TODO. In each case, that text provides a hint to the reader. It is not a paragraph of description, but it is better than the TODO begin converted to a comment and hidden from the reader.
In future posts, please help your readers by providing a link to the page that you are discussing.
Sure I’ll provide links in the future for better clarity. Sorry for the confusion regarding the term ‘current frontend docs’; I was referring to the fact that TODO notes are visible on the live developer site. Thanks for explaining why the community prefers to keep them there!
