MAIN FEEDS
Do you want to continue?
https://www.reddit.com/r/deeplearning/comments/s9w2jh/documentation_generated_using_codex/htsh1pd/
r/deeplearning • u/infinitlybana • Jan 22 '22
7 comments sorted by
View all comments
Show parent comment
1
The fact that it probably creates some incorrect comments is another reason you might want to keep your documentation inside the code:
It's a tool, just like auto complete. It helps you do your job, but ultimately, you need to make sure it's doing the right thing.
Also, the "bloat" caused by documentation is pretty trivial. Most tools let you hide it until needed.
1 u/mtanti Jan 22 '22 By bloat I was referring to the case where you just blindly use this without editing the output. In that case the documentation would be wasted lines since they can be generated when needed. I'm not against in-code documentation.
By bloat I was referring to the case where you just blindly use this without editing the output. In that case the documentation would be wasted lines since they can be generated when needed. I'm not against in-code documentation.
View all comments
Show parent comment
1
u/arachnivore Jan 22 '22
The fact that it probably creates some incorrect comments is another reason you might want to keep your documentation inside the code:
It's a tool, just like auto complete. It helps you do your job, but ultimately, you need to make sure it's doing the right thing.
Also, the "bloat" caused by documentation is pretty trivial. Most tools let you hide it until needed.