Hi Moshe, Why is consulting the online documentation insufficient? I think most developers build Django projects while referencing the online documentation rather than while reading Django's source code.
What 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 uninitiated. Are there other projects that use the approach you suggest? On Wednesday, January 3, 2024 at 2:38:02 PM UTC-5 Moshe Dicker wrote: > 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 > absolutely nothing useful. > > [image: image] > image1000×157 11.5 KB > > <https://global.discourse-cdn.com/business7/uploads/djangoproject/original/3X/d/f/df1eda85d38f5ff5978a7b966e2e4341bd45138a.png> > > What do the “Django Lords” have to say about inlining the documentation in > the source code itself. > > I know the “Django Lords” have been weary of adding type stubs. > However adding a docstring to this > ``` > class Model(models.Model): > ... > class Meta: <<<<< THIS > ... > ``` > > would require some stubs/.pyi files. > > I wouldn’t want to work on this just to find out that there are benefits > of the current setup that they aren’t willing to make a tradeoff. > > What would be the best way of asking the Django Governing Board about > their opinion on this? > -- You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group. To unsubscribe from this group and stop receiving emails from it, send an email to django-developers+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/d079d602-a11d-46ae-86c0-4bee9a8ff01bn%40googlegroups.com.
