Due to the dynamic nature of Python, features aren’t obvious.
Developers don’t know what features a class has unless they dig through the
convoluted source code themselves or going online to check the
documentation.
For example when implementing a `forms.ModelForm` hovering over it reveals
abso
hat sort of documentation would be inlined? Would this require a large
> amount of duplication between docs and source code?
>
> Why does adding docstrings require pyi files? My text editor doesn't have
> this "hover" feature. Please elaborate on your proposal for the
&g
Django’s API Reference is more like a guide than an actual Reference at
this point.
I’m proposing as follows:
1. We take any part of the reference that is short and to the point and
put it in a docstring.
I think going the FastAPI route on this would be best, A guide and a
separa
Django uses a lot of bootstrap/runtime patching under the hood, from custom
metaclasses, explicit injection
pattern up to proxies at various ends.
I understand this is true on low level APIs and on classes we implement
ourselves (Like passing the correct arguments when creating a django model)
I should not that I'm only being critical to improve.
The docs are well written, it's just disorganized.
I mean no disrespect, we stand on the shoulders of giant, but that doesn't
mean we should stop trying to improve.
On Wednesday, January 10, 2024 at 11:57:40 PM UTC-5 Mariusz Felisiak wrote:
>
