On 9/10/07, Rob Hudson <[EMAIL PROTECTED]> wrote: > > Hi Devs, > > One of the things I'm always stuck with when reading the docs is > knowing where to import the described methods or objects from. For > example, just now I'm working on Q objects and just read the > documentation but don't know where they live without having to jump > into the source of where I think they live. ... > 1) Add a footer to pages and when a new method or object is brought up > link to the footer which shows where it lives in the Django source.
I'm not sure a per-page footer is the best location for this. However, the general idea of an 'import index' is a reasonable idea. It could also provide a way to formalize what we consider to be 'stable API'. > 2) Use a HTML abbrev attribute so the user can hover the method name > or object name and see the appropriate "from django.db.models.query > import Q". I have two concerns with this idea: one practical, and one conceptual. At a practical level, I can think of an easy way to do this with ReST syntax (which is the source format for all the Django docs). The conceptual level is an extension of the pratical problem. ReST is designed to be human readable text. I'm slightly concerned that this idea would lead to documentation that loses it's plain-text readability. 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. Yours, Russ Magee %-) --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
