summaryrefslogtreecommitdiff
path: root/pod/perlmroapi.pod
diff options
context:
space:
mode:
authorPaul "LeoNerd" Evans <leonerd@leonerd.org.uk>2022-09-14 13:51:15 +0100
committerYves Orton <demerphq@gmail.com>2023-02-08 16:58:32 +0800
commitefa8f708cd0da7c71bb71920a47b545bd07bc28a (patch)
tree35dac76b1b17056bccf287879ba767ee3bcc165d /pod/perlmroapi.pod
parentbd90fa412bb2eb27ffa23a0e439350a39847521e (diff)
downloadperl-efa8f708cd0da7c71bb71920a47b545bd07bc28a.tar.gz
pod/perlmroapi.pod - document linear MRO function return type.
Small docs clarification to point out that the linear MRO function returns a list of strings
Diffstat (limited to 'pod/perlmroapi.pod')
-rw-r--r--pod/perlmroapi.pod8
1 files changed, 4 insertions, 4 deletions
diff --git a/pod/perlmroapi.pod b/pod/perlmroapi.pod
index ad6d1e3eb1..2345ca30a0 100644
--- a/pod/perlmroapi.pod
+++ b/pod/perlmroapi.pod
@@ -57,10 +57,10 @@ a I<level> of 0. The core always sets I<level> to 0 when it calls your
function - the parameter is provided to allow your implementation to track
depth if it needs to recurse.
-The function should return a reference to an array containing the parent
-classes in order. The names of the classes should be the result of calling
-C<HvENAME()> on the stash. In those cases where C<HvENAME()> returns null,
-C<HvNAME()> should be used instead.
+The function should return a reference to an array containing string SVs
+giving the names of parent classes in order. The names of the classes should
+be the result of calling C<HvENAME()> on the stash. In those cases where
+C<HvENAME()> returns null, C<HvNAME()> should be used instead.
The caller is responsible for incrementing the reference count of the array
returned if it wants to keep the structure. Hence, if you have created a