Merge branch 'master' into dependency-types
authorJoey Hess <joey@gnu.kitenet.net>
Thu, 8 Oct 2009 00:02:43 +0000 (20:02 -0400)
committerJoey Hess <joey@gnu.kitenet.net>
Thu, 8 Oct 2009 00:02:43 +0000 (20:02 -0400)
doc/plugins/write.mdwn

index 133030f08fc5bef55dc7dcf2fbca03add189a2db..8e8c3311e4a1a23e8e9d1f36f5689e7adba55269 100644 (file)
@@ -627,9 +627,13 @@ used to indicate weaker types of dependencies:
 
 #### `pagespec_match($$;@)`
 
-Passed a page name, and [[ikiwiki/PageSpec]], returns true if the
+Passed a page name, and [[ikiwiki/PageSpec]], returns a true value if the
 [[ikiwiki/PageSpec]] matches the page.
 
+Note that the return value is overloaded. If stringified, it will be a
+message indicating why the PageSpec succeeded, or failed, to match the
+page.
+
 Additional named parameters can be passed, to further limit the match.
 The most often used is "location", which specifies the location the
 PageSpec should match against. If not passed, relative PageSpecs will match