I used Trelent, an extension for VS code that didn’t require any registration, but their server has been unresponsive for a while. Any alternative you would recommend?
My code is in Python, mostly.

Edit: I wasn’t clear on my intention. I was looking for a tool that would lay out a generic description so I would start from something and fine tune the explanation.
I am incredibly bad at documenting, the process is tedious and frustrating. At the end of the day, my explanations are mostly gibberish anyway.
From your general consensus, I should bite the bullet and do it by myself.
I really appreciate your feedback, point taken. Time to psych myself up with some death metal and get it over with.

  • sirdorius
    link
    fedilink
    arrow-up
    11
    ·
    1 year ago

    Wow, the examples of Trelent are so incredibly useless. If you’re going to generate comments like that, just don’t. It is a waste of time to go through it as it is obvious from the function signature. And anything that could probably be written to be useful in the comment can’t be grasped by LLM. LLMs just add padding to data, they add no content.

    • snake_baitman@exploding-heads.com
      link
      fedilink
      arrow-up
      8
      ·
      1 year ago

      yeah, any comment that can be auto-generated doesn’t need to be there in the first place. The real issue might be overly-dogmatic comment/docstring requirements

      • mrkite
        link
        fedilink
        arrow-up
        7
        ·
        1 year ago

        Even worse. Auto generated comments just copy the how and not the why. If the code has a bug so does the comment… and if you fix the bug but not the comment somebody else might change the code back to match the comment.