Skip to content

Commit b2cc353

Browse files
committed
Add more deprecation info
Closes #4102
1 parent c76c09d commit b2cc353

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

doc/Type/Routine.pod6

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,8 @@ Calculating 43th prime
165165
191
166166
=end code
167167
168+
Marks something as I<deprecated>
169+
168170
=head2 trait is pure
169171
170172
multi sub trait_mod:<is>(Routine $r, :$pure!)
@@ -284,7 +286,14 @@ for more details.
284286
285287
multi sub trait_mod:<is>(Routine:D $r, :$DEPRECATED!)
286288
287-
Marks a routine as deprecated, optionally with a message what to use instead.
289+
Marks a C<Routine> as deprecated; that is, it should no longer be used going forward,
290+
and will eventually be removed. An optional message specifying the replacement
291+
functionality can be specified
292+
293+
By having both the original (deprecated) and new C<Routine> available simultaneously,
294+
you can avoid a breaking change in a single release, by allowing users time and instructions
295+
on how to update their code. Remove the deprecated verison only after at least
296+
one release that includes both the warning and the new C<Routine>.
288297
289298
This code
290299

0 commit comments

Comments
 (0)