Opened 10 years ago

Closed 9 years ago

#3694 closed (duplicate)

admin docstrings not added to doc pages because of stringfilter decorator

Reported by: Simon G. <dev@…> Owned by: Gary Wilson
Component: contrib.admin Version: master
Severity: Keywords:
Cc: dev@… Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

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 Changed 10 years ago by Chris Beaven

Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset
Triage Stage: UnreviewedDesign decision needed

Would another solution be to make the decorator _dec.__doc__ = func.__doc__?

comment:2 Changed 9 years ago by Gary Wilson

Owner: changed from nobody to Gary Wilson
Triage Stage: Design decision neededAccepted

comment:3 Changed 9 years ago by Gary Wilson

Resolution: duplicate
Status: newclosed

Marking this a dup of #5701 since the patch there fixes this.

Note: See TracTickets for help on using tickets.
Back to Top