Number 1 isn’t a show stopper in any way but is it pretty annoying. The primary django docs are very textual and place more emphasis on developing intuition and understanding context, than something that can be quickly referenced. Also a lot of the method parameters are either not documented or not explained. I think Django would benefit from a more technical and complete but less dense secondary reference.
“ more technical and complete but less dense secondary reference.”
Isn’t that basically just reading the source code? Like I get that’s probably not right to throw everyone toward, but reading source code is a staple task for working with FOSS.
A lot of devs don't understand this, but can save a lot of time, especially when the code is all python. Especially if you questions are off the beaten track
Django has one of the best source code base I ever saw, in 20+ years of doing software. If anyone has issues reading the Django source code, they probably should stay away from software development.
> If anyone has issues reading the Django source code, they probably should stay away from software development.
First of all, juniors exist you know that right? Please don't gatekeep.
Second, you're wrong. The Django codebase is overall good quality but if it's "one of the best you ever saw in 20 years" you haven't dug deep. Django has a lot of horrible no good bad awful parts to it. To their credit they tend to improve with age, not get worse, but it's certainly not worthy of such praise imo.
So you know better than me what source code I've read so far? Do you also happen to know what did I do with my spare camera battery? That could be useful.
I halfway agree. However in a multi-framework system I don’t have to time to learn the project structure of all my dependencies for quick lookup. Maybe if the Django docs linked to the underlying source code that would be a good compromise?
I fully agree, it usually ends up being barely useful, and not enough. It does not explain how certain parts of the magic happen, what the best practices are, what the expected types for arguments may be, etc.
It's not bad, but usually verbose in the wrong bits, and sparse in the details.
They have an entire set of tutorial/getting started type docs that are definitely very wordy and based around getting you comfortable with Django's paradigm, but they do have a rather well done API/Module reference that does a good job getting to the meat of the topic imo.
