> However, we're always interested in any way to make the documentation > better, so if you can come up with a way to make this idea work, we > can take a look at it.
That's the hard part and was hoping someone would have a bright idea. :) The best idea I've had is to spell out the full path to the object or method the first time it is used in the documentation, similar to how you spell out an acronym the first time but just use the acronym thereafter. eg: When a page is requested, Django creates an django.http.HttpRequest object that contains metadata about the request. Then Django loads the appropriate view, passing the HttpRequest as the first argument to the view function. Each view is responsible for returning an HttpResponse object. That gives enough context for a programmer to write an import statement or a path to view the source if they really want to dig deeper. And to me doesn't interrupt the flow of the reading at all. -Rob --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Django developers" 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-developers?hl=en -~----------~----~----~----~------~----~------~--~---
