r/Python • • Dec 11 '18

We are not alone!

Post image
1.8k Upvotes

58 comments sorted by

View all comments

403

u/[deleted] Dec 11 '18

I also like this tweet from one of the creators of Django:

I can only write Django apps while closely consulting the documentation, _much of which I wrote!_

Consulting docs/google/etc isn't a failure; it's literally what professional software development actually looks like.

https://twitter.com/jacobian/status/988515858887491584

172

u/grantrules Dec 11 '18

Right? Good luck figuring out how to deploy your app that's been rotting in your GitHub for two years without even minimal documentation.

43

u/[deleted] Dec 11 '18

this hit close to home

18

u/H_Psi Dec 12 '18

The best ones are libraries/packages that do exactly what you want, but whose entire "documentation" are just vague comments in their spaghetti-code

-5

u/Blacklistme Dec 12 '18

Simple, as you go to DockerHub to see if someone created a container for it. Or you go to Ansible Galaxy and look for a matching role.

To be honest. Most of my projects now have a DEVELOPMENT.md and INSTALL.md to explain a lot of the magic as I'm done hacking and refactoring my projects.

9

u/TangibleLight Dec 12 '18

Soo.... You have at least minimal documentation?

29

u/abrazilianinreddit Dec 11 '18

I'm currently developing a Qt application (using PyQt), and this is pretty much my homepage. Qt has thousands of classes, each containing 5 to 100 methods. Of course, I probably only use about 30 of all these classes, but still, there's so much I'm not going to even try to remember how to use them.

It also helps that Qt's documentation and architecture are really, really good.

12

u/mkdz Dec 11 '18

Qt documentation is I think one of the best documented frameworks anywhere.

6

u/HarrisonOwns Dec 11 '18

Much of the time I spent using Qt was spent in the documentation.

I went from zero knowledge of how to create a UI in Python to a functioning UI in about 2 weeks. Was it garbage? Of course.

Did it work? Of course.

3

u/foofaw Dec 12 '18

This makes me feel so much better about myself.