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 separate really robust API Reference that sources the technical info from the docstrings. Example: This <https://docs.djangoproject.com/en/5.0/ref/models/fields/#django.db.models.Field.null>, should be in the docstring of null. Implementation:class Foo: def __init__(self, value) -> None: """The Foo class. :param value: "Simple string value" :type value: str """ self.value = value foo = Foo(value="bar") 2. If this is rejected for whatever reason, can we please add just docstring to link to the online docs.class Foo: def __init__(self, value) -> None: """https://example.com"""; self.value = value foo = Foo(value= "bar") I'm coming from Flutter where the documentation is pretty much only inline docs, It's really a pleasure to never need to lookup documentation. This is a bunch of work. But having a lower barrier to entry is important. I think a docs refresh will really rock! -- 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/28393ec6-fb8c-4c3c-8f2a-55b56002ee42n%40googlegroups.com.
