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

Lemmy

2172 readers
3 users here now

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

For discussion about the lemmy.ml instance, go to [email protected].

founded 4 years ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
[–] Cr4yfish 41 points 1 year ago (4 children)

I just wished the Lemmy API docs were better lol.

[–] [email protected] 26 points 1 year ago (7 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

[–] danc4498 8 points 1 year ago* (last edited 1 year ago) (1 children)

More devs that don't want to write code?

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

[–] [email protected] 4 points 1 year ago

Well, more devs that have to sit down and figure out how the code works and then document it for future new devs

[–] [email protected] 7 points 1 year ago

I don't think that is contained to FOSS passion projects ;)

[–] [email protected] 4 points 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.

[–] [email protected] 4 points 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

[–] [email protected] 3 points 1 year ago

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

[–] c0c0c0 3 points 1 year ago

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

[–] [email protected] 1 points 1 year ago

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

[–] [email protected] 16 points 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 10 points 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.

[–] [email protected] 9 points 1 year ago

Fediverse software API documentation is bad across all fediverse software.