Opened 8 years ago

Closed 7 years ago

Last modified 6 years ago

#4328 task closed fixed (fixed)

Deprecate twisted.python.text.docstringLStrip

Reported by: Thijs Triemstra Owned by:
Priority: normal Milestone:
Component: core Keywords: easy
Cc: Thijs Triemstra Branch: branches/deprecate-docstringLStrip-4328
branch-diff, diff-cov, branch-cov, buildbot
Author: cyli

Description

No other code in Twisted uses this method and it hasn't been touched in 6 years;

"""Gets rid of unsightly lefthand docstring whitespace residue.

    You'd think someone would have done this already, but apparently
    not in 1.5.2.

    BUT since we're all using Python 2.1 now, use L{inspect.getdoc}
    instead.  I{This function should go away soon.}
    """

Change History (16)

comment:1 Changed 8 years ago by Jean-Paul Calderone

Keywords: easy added

Deprecate it first, of course.

comment:2 Changed 7 years ago by Thijs Triemstra

Owner: changed from Thijs Triemstra to Ying Li
Summary: Remove twisted.python.text.docstringLStripDeprecate twisted.python.text.docstringLStrip

comment:3 Changed 7 years ago by Ying Li

Author: cyli
Branch: branches/deprecate-docstringLStrip-4328

(In [29347]) Branching to 'deprecate-docstringLStrip-4328'

comment:4 Changed 7 years ago by Ying Li

Keywords: review added
Owner: Ying Li deleted

comment:5 Changed 7 years ago by Ying Li

(In [29354]) Deprecate twisted.python.text.docstringLStrip.

refs #4328

comment:6 Changed 7 years ago by Ying Li

Keywords: review removed

comment:7 Changed 7 years ago by Ying Li

(In [29355]) Ensure that flushWarnings only flushes the warnings dealing with this particular deprecation case.

refs #4328

comment:8 Changed 7 years ago by Ying Li

Keywords: review added

comment:9 Changed 7 years ago by Thijs Triemstra

Keywords: review removed
Owner: set to Ying Li

please remove the usage of L{} in the deprecation message because its not touched by epydoc afaik.

comment:10 Changed 7 years ago by Thijs Triemstra

the ref to python (2.1) should also go or be put into todays context.

comment:11 Changed 7 years ago by Ying Li

(In [29406]) Removed the L{} from deprecation messages, and deprecate as of 10.2 instead of 10.1

refs #4328

comment:12 Changed 7 years ago by Ying Li

Keywords: review added
Owner: Ying Li deleted

In regards to changing the docstringLStrip docstring, I think it should be left as is - it dates the method. Also, since it's going to be removed anyway, we probably shouldn't give the impression that we are still maintaining/modifying that method by updating the docstring.

comment:13 Changed 7 years ago by Jean-Paul Calderone

Keywords: review removed
Owner: set to Ying Li

Looks good to me. Please merge, assuming the build results look good.

comment:14 Changed 7 years ago by Ying Li

Resolution: fixed
Status: newclosed

(In [29448]) Merge deprecate-docstringLStrip-4328 : Deprecate t.p.text.docstringLStrip

Author: cyli Reviewer: thjis, exarkun Fixes: #4328

Deprecate twisted.python.text.docstringLStrip

comment:15 Changed 7 years ago by <automation>

Owner: Ying Li deleted

comment:16 Changed 6 years ago by Thijs Triemstra

#5036 will remove it.

Note: See TracTickets for help on using tickets.