I just stumbled into some doc mush, and wondering if some code wouldn't make the world a more accurately documented place.
It started with http://code.djangoproject.com/ticket/5870 which is basically help( send_mail ) says "NOTE: This method is deprecated. It exists for backwards compatibility." which should be in http://www.djangoproject.com/documentation/email/#send-mail, and some other discrepancies on that page. What I am wondering is how much sense it would make to link the docs on the web to the docstrings in the code (not replace, the web docs add value.) Basically, some way of quickly seeing what a method's interface really is, and what the docstring really says. (quickly= faster than having to open up a local copy of the file.) Example: http://www.djangoproject.com/documentation/email/#the-emailmessage-and-smtpconnection-classes The class has the following methods: * send() sends the message, using either the connection that is specified in the connection attribute, or creating a new connection if none already exists. make send() link to http://code.djangoproject.com/browser/django/trunk/django/core/mail.py#L257 (but somehow dynamically figure out the URL) or some ajax that somehow displays send(self, fail_silently=False) Send the email message. or just load up all the doc strings on each page view. Not sure if it is worth the extra server load. Is this worth considering? Carl K --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Django developers" group. To post to this group, send email to django-developers@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/django-developers?hl=en -~----------~----~----~----~------~----~------~--~---
