#1248: [patch] API Reference
---------------------------------+------------------------------------------
Reporter: [EMAIL PROTECTED] | Owner: jacob
Status: closed | Component: Documentation
Version: | Resolution: wontfix
Keywords: API Reference | Stage: Design decision needed
Has_patch: 1 | Needs_docs: 0
Needs_tests: 0 | Needs_better_patch: 0
---------------------------------+------------------------------------------
Changes (by jacob):
* status: new => closed
* resolution: => wontfix
Comment:
IMO (and in that of most of the Django developers I've talked to),
automatically generated API documentation is -- at best -- a poor excuse
for not having real docs. I'd rather spend my time writing real docs, and
I'd prefer the community do the same.
Thus, I'm marking this WONTFIX.
If anyone's reading this and gets pissed, here are the circumstances under
which I'd consider adding an automatically generated API doc somewhere on
the site. I'd only consider a tool that:
* Is easily customizable (i.e. uses some sort of same template for the
output).
* Doesn't use frames (seriously).
* Has some sort of commenting or wiki-like functionality to allow the
community to annotate APIs.
If anyone knows of such a tool then let me know.
--
Ticket URL: <http://code.djangoproject.com/ticket/1248#comment:8>
Django Code <http://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 post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en
-~----------~----~----~----~------~----~------~--~---
