QuerySet method docs headings contain entire method signatures
|Reported by:||Gabriel Hurley||Owned by:||Adam Vandenberg|
|Has patch:||no||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
Take a look at this URL (the URL itself, not the page):
Basically, the headings for the
QuerySet methods (and consequently the hash for the anchors in the URLs) contain the entire method signature. This is completely non-functional (as opposed to the
:method: declarations directly beneath the headings), it adds unnecessary detail to the page's TOC, and it makes the URLs for those anchors unbearably long/cluttered.
As such, the headings for those methods should all be reduced to simply the name of the method, leaving the method signature defined below.
It looks like the duplication stems from the headings having been written first, and left in place as-is after the method directives were added.
The only downside to fixing this is that any existing external links directly to one of these anchors would now go to top of the page rather than directly to the section within the page.
Change History (7)
comment:1 Changed 6 years ago by
|Owner:||changed from nobody to Adam Vandenberg|
|Patch needs improvement:||unset|