smcvpostcomment: explain what $fake is for

[ikiwiki.git] / IkiWiki / Plugin / smcvpostcomment.pm

diff --git a/IkiWiki/Plugin/smcvpostcomment.pm b/IkiWiki/Plugin/smcvpostcomment.pm
index 367f2d9b3c56a5fcc881c5acf33208c985ddf711..f224944d51f1a21cdf3a02d4677046c7f1e2d710 100644 (file)
--- a/IkiWiki/Plugin/smcvpostcomment.pm
+++ b/IkiWiki/Plugin/smcvpostcomment.pm
@@ -215,6 +215,8 @@ sub sessioncgi ($$) { #{{{
        # - this means that if they do, rocks fall and everyone dies
 
        if ($form->submitted eq PREVIEW) {
+               # $fake is a location that has the same number of slashes
+               # as the eventual location of this comment.
                my $fake = "$page/_" . PLUGIN . "hypothetical";
                my $preview = IkiWiki::htmlize($fake, $page, 'mdwn',
                                IkiWiki::linkify($page, $page,