Commit6715be7

authored

PEP 702: Tools may clean up the deprecation message (#3482)

Seehttps://discuss.python.org/t/pep-702-marking-deprecations-using-the-type-system/23036/53?u=jelleI don't want to prescribe the exact behavior on tools and IDEs; theycan figure out for themselves what works best. This change is intendedto make it so they can adjust the message without worrying that theyare breaking the specification.

1 parent43bdd16 commit6715be7Copy full SHA for 6715be7

File tree

-0

lines changed

-0

lines changed

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,8 @@ The decorator takes the following arguments:`
`115`	`115`
`116`	`116`	The positional-only argument is of type ``str`` and contains a message that should
`117`	`117`	`be shown by the type checker when it encounters a usage of the decorated object.`
	`118`	`+Tools may clean up the deprecation message for display, for example`
	`119`	+by using:func:`inspect.cleandoc` or equivalent logic.
`118`	`120`	`The message must be a string literal.`
`119`	`121`	`The content of deprecation messages is up to the user, but it may include the version`
`120`	`122`	`in which the deprecated object is to be removed, and information about suggested`

Comments

(0)