Skip to content

Commit 18953db

Browse files
committed
[Mu] communicate intent of methods Str and gist
1 parent cb9871d commit 18953db

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

lib/Mu.pod

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,19 @@ Returns C<False> on the type object, and C<True> otherwise
3232
3333
multi method Str() returns Str
3434
35-
Returns implementation-defined identifier.
35+
Returns a string representation of the invocant, inteded to be machine
36+
readable.
3637
3738
=head2 gist
3839
3940
multi sub gist(Mu) returns Str
4041
multi method gist() returns Str
4142
42-
Returns result of using C<.perl> method on current object.
43+
Returns a string representation of the invocant, optimized for
44+
fast recognition by humans.
45+
46+
The default C<gist> method in C<Mu> re-dispatches to the C<perl> method,
47+
but many built-in classes override it to something more specific.
4348
4449
=head2 perl
4550

0 commit comments

Comments
 (0)