Opened 18 years ago
Closed 17 years ago
#3694 closed (duplicate)
admin docstrings not added to doc pages because of stringfilter decorator
Reported by: | Owned by: | Gary Wilson | |
---|---|---|---|
Component: | contrib.admin | Version: | dev |
Severity: | Keywords: | ||
Cc: | dev@… | Triage Stage: | Accepted |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
The decorator stringfilter
in defaultfilters.py overrides the docstrings, making the documentation for those filters in /admin/doc/filters/
empty.
This is similar to #1840, but in a different component and with a different side effect, however the discussion there might prove useful in resolving this. A possible (ugly)solution may be to call stringfilter inside all the filters which need it, rather than decorating.
Change History (3)
comment:1 by , 18 years ago
Triage Stage: | Unreviewed → Design decision needed |
---|
comment:2 by , 17 years ago
Owner: | changed from | to
---|---|
Triage Stage: | Design decision needed → Accepted |
comment:3 by , 17 years ago
Resolution: | → duplicate |
---|---|
Status: | new → closed |
Marking this a dup of #5701 since the patch there fixes this.
Note:
See TracTickets
for help on using tickets.
Would another solution be to make the decorator
_dec.__doc__ = func.__doc__
?