runeks 3 days ago

Useful documentation explains why the code does what it does. Ie. why is this code there?

An LLM can't magically figure out your motivation behind doing something a certain way.

Reply View 3 replies
  • bonzini 3 days ago

    Tell it the why of the API and ask it to write individual function and class docs then.

    Reply View 0 replies
  • johnnyyyy 3 days ago

    Are you implying that only the creator of the code can write documentation?

    Reply View 1 reply
    • oblio 3 days ago

      No, they're saying that LLMs (and really, most other humans) can't really write the best documentation.

      Frankly, most documentation is useless fluff. LLMs will be able to write a ton of that for sure :-)

      Reply View 0 replies
tdy_err 3 days ago

Alternatively, document your code.

Reply View 1 reply
  • cushychicken 3 days ago

    Id have bought a lot of lunches for myself if I had a dollar for every time I’ve pushed my team for documentation and had it turn into a discussion of “Well, how does that stack up against other priorities?”

    It’s a pretty foolproof way for smart political operators to get out of a relatively dreary - but high leverage - task.

    AI doesn’t complain. It just writes it. Makes the whole task a lot faster when a human is a reviewer for correctness instead of an author and reviewer.

    Reply View 0 replies