stdlib: Implement head() and tail() functions.

[goals.git] / docs / Goalfile.pod

diff --git a/docs/Goalfile.pod b/docs/Goalfile.pod
index 9917fd0..37f3c07 100644 (file)
--- a/docs/Goalfile.pod
+++ b/docs/Goalfile.pod
@@ -38,6 +38,14 @@ For example:
 
 Returns the filename extension.
 
 
 Returns the filename extension.
 

+=head3 head (list)
+
+For example:
+
+ head (["a", "b", "c"]) ⇒ "a"
+
+Returns the head (first) element of the list.
+

 =head3 join (list1, list2)
 
 For example:
 =head3 join (list1, list2)
 
 For example:


@@ -48,6 +56,15 @@ Concatenate C<list1> and C<list2>.  It's not usually necessary to use
 this function since goals automatically flattens lists within lists
 into simple lists in many cases.
 
 this function since goals automatically flattens lists within lists
 into simple lists in many cases.
 

+=head3 realpath (filename)
+
+For example:
+
+ realpath ("./tests") ⇒ "/home/user/tests"
+
+Run the L<realpath(1)> command to return the resolved absolute path of
+the C<filename> parameter.
+

 =head3 sort (list)
 
 For example:
 =head3 sort (list)
 
 For example:


@@ -67,6 +84,14 @@ This function works something like make’s C<subst> function, except
 that C<from> is a regular expression, specifically a L<sed(1)>
 extended regular expression.
 
 that C<from> is a regular expression, specifically a L<sed(1)>
 extended regular expression.
 

+=head3 tail (list)
+
+For example:
+
+ tail (["a", "b", "c"]) ⇒ ["b", "c"]
+
+Returns the tail (all except first) elements of the list.
+

 =head3 wildcard (pattern)
 
 For example:
 =head3 wildcard (pattern)
 
 For example: