Hacker News new | ask | show | jobs
by ollien 780 days ago
Pydantic falls into this box for me. The maintainer refuses to build API reference documentation, as they feel that there should only be one source of information. It's their project, of course, but every time I need to find a method on an object, I am scouring pages of prose for it. Sometimes it's just easier to read the source.
2 comments

What's missing from the existing API documentation?

https://docs.pydantic.dev/latest/api/base_model/

Oh nice! I'll admit, my comment was based on outdated knowledge (the last time I used Pyandtic for a major project was in 1.x).

https://github.com/pydantic/pydantic/issues/1339

Haproxy does the whole documentation side of things very well.

The docs are very straightforward and thorough.