X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/f8a7fb227b59463b37180b1e525c5d19ec0e43cb..e739073c386603bbaac05f409381b58761942597:/doc/plugins/write.mdwn diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index ef9d412e5..0eef3d2ba 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -328,10 +328,6 @@ The most often used is "location", which specifies the location the PageSpec should match against. If not passed, relative PageSpecs will match relative to the top of the wiki. -If the PageSpec fails to match, it may return a IkiWiki::FailReason object, -which evaluates to false in a boolean context, but in a string context, -evaulates to the reason the PageSpec failed to match. - #### `bestlink($$)` Given a page and the text of a link on the page, determine which @@ -452,5 +448,5 @@ IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is how it will be accessed in a [[PageSpec]]. The function will be passed two parameters: The name of the page being matched, and the thing to match against. It may also be passed additional, named parameters. It should return -true if the match succeeds, and either false or a IkiWiki::FailReason object -if the match fails. +a IkiWiki::SuccessReason object if the match succeeds, or an +IkiWiki::FailReason object if the match fails.