No standard method of indicating import paths in documentation
|Reported by:||davesque@…||Owned by:||nobody|
|Has patch:||no||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
I've been using Django for about a year now and there's something about the Django documentation that's always seemed inconvenient to me.
If you're ever reading about a class, function, etc. in docs, it's rarely obvious where to import that resource from. The module path is almost never indicated a consistent or obvious way.
For example, take a look at this doc page:
What I would expect is that, directly above this heading or somewhere similar, the full import path of the class would be indicated in some way. Perhaps like this:
...or something like that. I'm aware of the hash links next to each heading which contain the full import path. This is fine, but that information should not be hidden. It should be on the page in plain view.
I think we should launch an initiative to fix this problem with usability in the Django docs.
Change History (4)
comment:1 Changed 14 months ago by davesque@…
- Needs documentation unset
- Needs tests unset
- Patch needs improvement unset
comment:2 Changed 14 months ago by davesque@…
- Type changed from Uncategorized to Cleanup/optimization