Skip Menu |
 

This queue is for tickets about the Konstrukt CPAN distribution.

Report information
The Basics
Id: 51854
Status: new
Priority: 0/
Queue: Konstrukt

People
Owner: Nobody in particular
Requestors: FWIE [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: (no value)
Broken in: (no value)
Fixed in: (no value)



Subject: [Patch] POD nits
The attached patch fixes some POD, which renders wrong, at least at search.cpan.org.
Subject: pod.patch
Download pod.patch
text/x-diff 6.2k
diff --git a/lib/Konstrukt/Cache.pm b/lib/Konstrukt/Cache.pm index cb4a863..48bbdd5 100644 --- a/lib/Konstrukt/Cache.pm +++ b/lib/Konstrukt/Cache.pm @@ -501,7 +501,7 @@ Returns undef otherwise. Will also add the path to the requested file to the stack of current directories, B<if> there is a valid cached file available. -So you should call C<$Konstrukt::File->pop()> when you're done with the file you +So you should call C<< $Konstrukt::File->pop() >> when you're done with the file you read from the cache. B<Parameters>: diff --git a/lib/Konstrukt/File.pm b/lib/Konstrukt/File.pm index 0d240d7..0df4ed4 100644 --- a/lib/Konstrukt/File.pm +++ b/lib/Konstrukt/File.pm @@ -81,7 +81,7 @@ B<Parameters>: =over -=item * $root - The pseudo-root dir. Will be the root of a C<$Konstrukt::File->read('/path/file')>. +=item * $root - The pseudo-root dir. Will be the root of a C<< $Konstrukt::File->read('/path/file') >>. Usually your document root. Should always be an absolute path, otherwise you may get really weird results. @@ -359,7 +359,7 @@ L</current_file> method. The root directory will be the one specified on construction of this object (usually your document root). -C<$Konstrukt::File->read_and_track('/test.txt')> will read the file test.txt +C<< $Konstrukt::File->read_and_track('/test.txt') >> will read the file test.txt located in the document root, not in the system root. A file read with this method will be put on a stack of "open" files. So all files @@ -408,7 +408,7 @@ Will read a file relatively to the current directory. The root directory will be the one specified on construction of this object (usually your document root). -C<$Konstrukt::File->read('/test.txt')> will read the file test.txt +C<< $Konstrukt::File->read('/test.txt') >> will read the file test.txt located in the document root, not in the system root. B<Parameters>: @@ -437,7 +437,7 @@ Will write a file relatively to the current directory. The root directory will be the one specified on construction of this object (usually your document root). -C<$Konstrukt::File->write('/test.txt', 'some data')> will (over)write the file test.txt +C<< $Konstrukt::File->write('/test.txt', 'some data') >> will (over)write the file test.txt located in the document root, not in the system root. B<Parameters>: diff --git a/lib/Konstrukt/Plugin.pm b/lib/Konstrukt/Plugin.pm index 729aa24..a00043b 100644 --- a/lib/Konstrukt/Plugin.pm +++ b/lib/Konstrukt/Plugin.pm @@ -254,7 +254,7 @@ B<Parameters>: =item * $tag - Reference to the tag node (and its children) that shall be handled. Contains the plugin tag in the parse tree and all related information - espeacially -the tag attributes (C<$tag->{tag}->{attributes}>) and the content inside the tag: +the tag attributes (C<< $tag->{tag}->{attributes} >>) and the content inside the tag: my $node = $tag->{first_child}; while (defined $node) { @@ -298,7 +298,7 @@ B<Parameters>: =item * $tag - Reference to the tag node (and its children) that shall be handled. Contains the plugin tag in the parse tree and all related information - espeacially -the tag attributes (C<$tag->{tag}->{attributes}>) and the content inside the tag: +the tag attributes (C<< $tag->{tag}->{attributes} >>) and the content inside the tag: my $node = $tag->{first_child}; while (defined $node) { diff --git a/lib/Konstrukt/Plugin/captcha.pm b/lib/Konstrukt/Plugin/captcha.pm index 9a8f51c..ecd0b49 100644 --- a/lib/Konstrukt/Plugin/captcha.pm +++ b/lib/Konstrukt/Plugin/captcha.pm @@ -88,7 +88,7 @@ the captcha part of the input dialogue (i.e. the captcha question and the input fields for the answer (C<name="captcha_answer">)and the hash checksum (C<name="captcha_hash">)). -This will be done like every (simple) plugin does via C<print> or C<$self->add_node()> +This will be done like every (simple) plugin does via C<print> or C<< $self->add_node() >> (see L<Konstrukt::Plugin/add_node>). You might want to take an existing implementation as a template. diff --git a/lib/Konstrukt/Plugin/errors.pm b/lib/Konstrukt/Plugin/errors.pm index 80fd1dc..6d1cc41 100644 --- a/lib/Konstrukt/Plugin/errors.pm +++ b/lib/Konstrukt/Plugin/errors.pm @@ -17,7 +17,7 @@ A list of the errors, that occurred during the processing of the file, if any. =head1 DESCRIPTION Will display the error messages (if any) that have been created with -C<$Konstrukt::Debug->error_message()>. +C<< $Konstrukt::Debug->error_message() >>. A template named C<error.template> will be used to display them. The template must have a list C<errors>, which must have a field C<text>. diff --git a/lib/Konstrukt/Plugin/wiki/backend/article.pm b/lib/Konstrukt/Plugin/wiki/backend/article.pm index bf64cb2..578389c 100644 --- a/lib/Konstrukt/Plugin/wiki/backend/article.pm +++ b/lib/Konstrukt/Plugin/wiki/backend/article.pm @@ -47,7 +47,7 @@ use Konstrukt::Plugin; #import use_plugin Initialization for this plugin. If you overwrite this one in your implementation, make sure to call -C<$self->SUPER::init(@_);> to let the base class (this class) also do its init work. +C<< $self->SUPER::init(@_); >> to let the base class (this class) also do its init work. =cut sub init { diff --git a/lib/Konstrukt/Plugin/wiki/backend/file.pm b/lib/Konstrukt/Plugin/wiki/backend/file.pm index 7deca18..f3e7a42 100644 --- a/lib/Konstrukt/Plugin/wiki/backend/file.pm +++ b/lib/Konstrukt/Plugin/wiki/backend/file.pm @@ -49,7 +49,7 @@ use Konstrukt::Plugin; #import use_plugin Initialization for this plugin. If you overwrite this one in your implementation, make sure to call -C<$self->SUPER::init(@_);> to let the base class (this class) also do its init work. +C<< $self->SUPER::init(@_); >> to let the base class (this class) also do its init work. =cut sub init { diff --git a/lib/Konstrukt/Plugin/wiki/backend/image.pm b/lib/Konstrukt/Plugin/wiki/backend/image.pm index 46559d1..6859ed7 100644 --- a/lib/Konstrukt/Plugin/wiki/backend/image.pm +++ b/lib/Konstrukt/Plugin/wiki/backend/image.pm @@ -52,7 +52,7 @@ use Konstrukt::Plugin; #import use_plugin Initialization for this plugin. If you overwrite this one in your implementation, make sure to call -C<$self->SUPER::init(@_);> to let the base class (this class) also do its init work. +C<< $self->SUPER::init(@_); >> to let the base class (this class) also do its init work. =cut sub init {


This service is sponsored and maintained by Best Practical Solutions and runs on Perl.org infrastructure.

Please report any issues with rt.cpan.org to rt-cpan-admin@bestpractical.com.