Opened 12 years ago
Closed 11 years ago
#17599 closed Bug (duplicate)
Admindocs Example Misleading
| Reported by: | Mark Lavin | Owned by: | nobody |
|---|---|---|---|
| Component: | contrib.admindocs | Version: | 1.3 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | yes |
| Easy pickings: | no | UI/UX: | no |
Description
https://docs.djangoproject.com/en/1.3/ref/contrib/admin/admindocs/#model-reference states shows an example of using the :model:`app_name.model_name` reference in the doc string of a Model. However, this does not create the hyperlink as indicated by the prior section. As you can see in the view the model's docstring is passed into the context without any addition parsing.
Attachments (1)
Change History (6)
comment:1 by , 12 years ago
| Triage Stage: | Unreviewed → Accepted |
|---|
by , 12 years ago
| Attachment: | 17599-draft.patch added |
|---|
comment:2 by , 12 years ago
| Has patch: | set |
|---|---|
| Patch needs improvement: | set |
comment:3 by , 12 years ago
Still present in 1.4, the docs very clearly state this should work when it very clearly doesn't.
comment:4 by , 12 years ago
Is this patch going to be included into any next releases ? I confirm the problem is still in 1.4
Another question is how can we help improving the patch ?
comment:5 by , 11 years ago
| Resolution: | → duplicate |
|---|---|
| Status: | new → closed |
Duplicate of ancient #5405.
Note:
See TracTickets
for help on using tickets.
I'm attaching a rough sketch of how we could improve the admindoc page for models.