Skip to content

Commit

Permalink
Add another function signature example
Browse files Browse the repository at this point in the history
The 'constants' section was removed because the interpreter flags are now
documented and there do not appear to be other constants to document.
  • Loading branch information
leto committed Dec 18, 2010
1 parent b294b0f commit 00d1cb7
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions docs/embed.pod
Expand Up @@ -81,10 +81,6 @@ Parrot's unsigned integer numeric type.

=back

=head2 Constants

Not documented yet.

=head2 Function signatures

What is a function signature? It is a string which represents the calling and
Expand All @@ -102,15 +98,17 @@ the datatypes on the right are the datatype being returned.

Here are some example function signatures and what they mean:

INN->N In: Integer, two Numerics Out: Numeric
P->S In: PMC Out: String
PiP->S In: PMC (method call) Out: String
NN->N In: Two Numerics Out: Numeric
I->I In: Integer Out: Integer
I->N In: Integer Out: Numeric
Pi-> In: none (method call) Out: none
->I In: none Out: Integer
-> In: none Out: none
INN->N In: Integer, two Numerics Out: Numeric
SIN->S In: String, Integer, Numeric Out: String
P->S In: PMC Out: String
PiP->S In: PMC (method call) Out: String
NN->N In: Two Numerics Out: Numeric
I->I In: Integer Out: Integer
I->N In: Integer Out: Numeric
N->P In: Numeric Out: PMC
Pi-> In: none (method call) Out: none
->I In: none Out: Integer
-> In: none Out: none

TODO: Multiple return values? Spaces?

Expand Down

0 comments on commit 00d1cb7

Please sign in to comment.