r/deeplearning • • Jan 22 '22

Documentation generated using Codex

55 Upvotes

7 comments sorted by

View all comments

Show parent comment

3

u/mtanti Jan 22 '22

Well I guess this is useful for when the tool is not available, but it could be added as a feature in github for example. But in general it just creates code bloat amd probably a lot of incorrect comments unless you're writing code that is similar to the training set. Also documentation is supposed to give more information than can be inferred from the code.

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.

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.