#11800 closed (fixed)
Remove extra metadata from QuerySet API
| Reported by: | Tim Graham | Owned by: | Tim Graham |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Keywords: | ||
| Cc: | Triage Stage: | Ready for checkin | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description (last modified by )
Attached is a patch that adds content-sensitive Sphinx markup to the API documentation, replacing old-style ReST markup.
Attachments (1)
Change History (9)
comment:1 Changed 14 years ago by
| Description: | modified (diff) |
|---|---|
| Triage Stage: | Unreviewed → Ready for checkin |
comment:2 follow-up: 4 Changed 14 years ago by
I believe Jacob has been working on/did a patch for Sphinx that allowed any literals to automatically become cross references, so this may be unnecessary.
comment:3 Changed 13 years ago by
| Patch needs improvement: | set |
|---|---|
| Triage Stage: | Ready for checkin → Accepted |
Patch no longer applies cleanly.
comment:4 Changed 13 years ago by
Replying to Alex:
I believe Jacob has been working on/did a patch for Sphinx that allowed any literals to automatically become cross references, so this may be unnecessary.
I did something similar as what timo did in this ticket for the ':setting:', ':mod:', ':class:', :data: and ':attr:' xref targets over all the documetation during the 1.1.x cycle in #9502, updating it during almost four months so it always applied cleanly both for trunk and the 1.0.x branch. In the end I abandoned it because after asking why it wasn't applied on IRC I was told a solution was coming RSN and would render that patch obsolete.
We need to decide and make public what we are going to do with this stuff so to to not waste contributors energy spent in adding metadata to the docs and end with patches that get outdated (it's one of our docs TODO list).
comment:5 Changed 13 years ago by
| Owner: | changed from nobody to Tim Graham |
|---|---|
| Status: | new → assigned |
This is mostly a duplicate of #12997 at this point, although as I pointed out in that ticket, the current metadata is a bit broken. There a few things to cleanup so I'll redo this patch at some point.
ramiro, did you get any clarification on the issue of linking? (I noticed you "won't fixed" #9502). If it's no longer needed or wanted, we should remove it from the TODO list as you noted.
Changed 13 years ago by
| Attachment: | 11800.diff added |
|---|
comment:6 Changed 13 years ago by
| Patch needs improvement: | unset |
|---|---|
| Summary: | Add metadata to QuerySet API → Remove extra metadata from QuerySet API |
| Triage Stage: | Accepted → Ready for checkin |
modifying patch to remove extra metadata after additions in #12997
comment:7 Changed 13 years ago by
| Resolution: | → fixed |
|---|---|
| Status: | assigned → closed |
@timo - thanks for the patch, but seriously - a ticket description isn't an optional extra. "Add metadata to QuerySet API"? WTF does that mean?