• drcobaltjedi@programming.dev
      link
      fedilink
      English
      arrow-up
      24
      ·
      1 year ago

      Yeah, that’s a problem with a lot of FOSS passion projects. We devs kinda like writting code, but not really documenting it. Hopefully with the influx of devs helping that will improve

      • danc4498@lemmy.world
        link
        fedilink
        English
        arrow-up
        9
        arrow-down
        1
        ·
        edit-2
        1 year ago

        More devs that don’t want to write code?

        Edit: damn, meant to say write documentation. We only want to code!

      • Boinketh@lemm.ee
        link
        fedilink
        English
        arrow-up
        4
        ·
        1 year ago

        It’s a pretty major pain point for a lot of local libraries, too. I’m so glad I have the option to dig through the source code of functions if I can’t figure them out.

      • Acheron@sh.itjust.works
        link
        fedilink
        English
        arrow-up
        4
        ·
        1 year ago

        I don’t really like all the LLM hype, but I’m hoping that documentation will eventually be generated by some open source model, with human verification

    • tool@r.rosettast0ned.com
      link
      fedilink
      English
      arrow-up
      13
      ·
      1 year ago

      I just wished the Lemmy API docs were better lol.

      Finnegans Wake makes more sense than Lemmy API docs. Even calling it “documentation” is a stretch.

      I literally had to clone the Lemmy git repo and read the source code to find the implementation of an API endpoint and see how it worked for a script that I was writing.

    • Fauzruk@lemmy.world
      link
      fedilink
      English
      arrow-up
      10
      ·
      1 year ago

      These days the standard is to create an API Doc out of a OpenAPI document generated from the code itself. Someone will probably contribute to it at some point.