@@ -97,34 +97,34 @@ def deprecated(
9797 property, and 'function' otherwise.
9898
9999 Args:
100- since : str
100+ since:
101101 The release at which this API became deprecated.
102- message : str, optional
102+ message:
103103 Override the default deprecation message. The %(since)s,
104104 %(name)s, %(alternative)s, %(obj_type)s, %(addendum)s,
105105 and %(removal)s format specifiers will be replaced by the
106106 values of the respective arguments passed to this function.
107- name : str, optional
107+ name:
108108 The name of the deprecated object.
109- alternative : str, optional
109+ alternative:
110110 An alternative API that the user may use in place of the
111111 deprecated API. The deprecation warning will tell the user
112112 about this alternative if provided.
113- alternative_import: str, optional
113+ alternative_import:
114114 An alternative import that the user may use instead.
115- pending : bool, optional
115+ pending:
116116 If `True`, uses a `PendingDeprecationWarning` instead of a
117117 DeprecationWarning. Cannot be used together with removal.
118- obj_type : str, optional
118+ obj_type:
119119 The object type being deprecated.
120- addendum : str, optional
120+ addendum:
121121 Additional text appended directly to the final message.
122- removal : str, optional
122+ removal:
123123 The expected removal version. With the default (an empty
124124 string), a removal version is automatically computed from
125125 since. Set to other Falsy values to not schedule a removal
126126 date. Cannot be used together with pending.
127- package: str, optional
127+ package:
128128 The package of the deprecated object.
129129
130130 Returns:
0 commit comments