#22663: Documentation of "for internal use only" code
-------------------------------+--------------------------------------
Reporter: EvilDMP | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------
Comment (by timo):
I don't have an opinion on the functions in question, but just wanted to
chime in on the purpose of Django's documentation according to... itself.
From [https://docs.djangoproject.com/en/dev/misc/api-stability/ API
Stability]: "All the public APIs (everything in this documentation) will
not be moved or renamed without providing backwards-compatible aliases."
I think you would agree that not everything in `django.utils` should be
documented. Is your main concern that some functions in a given file are
documented, but not others? I think we should be free to add things in
`django.utils` where they make sense without worrying about them being
robust, stable APIs. Keep the main thing (a web development framework),
the main thing.
--
Ticket URL: <https://code.djangoproject.com/ticket/22663#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/065.d7c2ef7d5ae20961687dc4d24b108245%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
