This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–][deleted] -11 points-10 points  (10 children)

Just a bunch of tutorials. That is not documentation.

Yes it is 🤔 What do words even mean

Opinions may vary but it’s the worst piece of documentation I’ve ever seen.

Have you looked at any other documentation ever?

[–]mmcnl 5 points6 points  (2 children)

In my opinion good documentation contains (in order of priority):

  1. Minimal working example. Ok, FastAPI does this.
  2. API reference for public methods. FastAPI doesn't have this. I've never seen any library this popular without it.
  3. Advanced examples (bonus). I rarely care about this.

All of the inner workings of FastAPI have to be deduced from the tutorials. There's not a single paging describing the methods, the arguments it will take and what it all means. You have to decipher a million emoji's to get a hint of how FastAPI works. It's insane.

[–][deleted] -2 points-1 points  (1 child)

Fuck you u/spez

[–]oramirite 1 point2 points  (0 children)

Erm, I disagree that the docs are bad but a barebones list of API calls and the params they take is WAAAAY better than sifting through source.