Hacker News new | ask | show | jobs
by Aperocky 1141 days ago
I like semi-automatically generated docs like AWS API docs that contains in minimum the type information for every field there is, and often much more.

I don't like Python docs where it ends up on long winded explanation for specific cases but does not cover all arguments, or only mention some in passing.

1 comments

I am the exact opposite. I dislike semi automatic docs like most rust libraries have that don't tell you anything about how you're supposed to use things, and I love the general python docs that are the opposite. Django in particular is super good at this.

I would compare it to having a recipe vs a list of ingredients. Both are useful but I can't just cook if you just give me a list of ingredients without instructions.

And then you have NestJS that does neither so you just get a random piece of information but missing 75% of instructions and no good API doc.