2

BeautifulSoup (python module) doc is a single block of text which has an everlasting scrolling and hard to read. Examples are ok, but come on, we're devs, not text parsers. We need clear, clean and visual documentation. I neither like the organization of the Facebook API docs. It was a nightmare to build my first simple app. There are tons of this kind of messy, almost unreadable and confusing docs. It's strange, but usually these kind of docs are related to open source projects. Long life to markdown and github.

Comments
  • 1
    This is very true unfortunately
  • 1
    @Defi4NT not happy being in reason with this, but ... I like to read and learn, not to fight against a bunch of unordered nonsense characters in a single block.
  • 1
    Agreed
    As a matter of fact I was just reading the doc yesterday night and at the end I realized
    '' this is nonsense ''
    The exemples helped a bit but not in context
    I had to go to SO and YouTube to find something understandable
  • 1
    I'd forked and I'm reworking an outdated parsing library in Python which uses different modules avaliable for the task just for learning purposes, and I'm learning a lot more by try-fail than the doc itself. As you say, examples are not in context. I'm reworking the poor doc the project has as well, and I believe it, it's hard to do both things at the same time. But it really pays in long term. The future yourself will be kissing his own ass for that! 😂
Add Comment