Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

I like that FastAPI has documentation meant to be read from beginning to end. It walks you through not only the how but the why of core design decisions, and even dives into ancillary things like pydantic. This is in sharp contrast to most python packages of modest size where IMHO the bare minimum effort is put into technical docs. Usually you get something using a 10+ year old Sphinx template that hasn't changed for modern devices, and no description of usage is more than a trite paragraph (i.e. the attention span of a developer writing a docstring).


Agreed. This is an issue not only in Python. How many Java packages documentation is just generated Javadoc?




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: