this post was submitted on 12 Jul 2023
1291 points (99.5% liked)

Lemmy

13479 readers
78 users here now

Everything about Lemmy; bugs, gripes, praises, and advocacy.

For discussion about the lemmy.ml instance, go to !meta@lemmy.ml.

founded 5 years ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
[–] Cr4yfish@lemmy.world 16 points 2 years ago (2 children)

I just wished the Lemmy API docs were better lol.

[–] drcobaltjedi@programming.dev 20 points 2 years ago (6 children)

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

[–] Acheron@sh.itjust.works 4 points 2 years 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

[–] c0c0c0@lemmy.world 3 points 2 years ago

Maybe we'll eventually get the corresponding influx of tech writers.

[–] Boinketh@lemm.ee 3 points 2 years 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.

[–] tool@r.rosettast0ned.com 3 points 2 years ago

I think that this line of reasoning becomes less and less tenable when things like Swagger exist.

[–] astral_avocado@programming.dev 1 points 2 years ago

It's like almost every piece of software, period.

load more comments (1 replies)
[–] tool@r.rosettast0ned.com 13 points 2 years 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.