1. Manuals
  2. Tumbleweed
  3. perl-Code-TidyAll
  4. Code::TidyAll::Plugin::PodChecker(3pm)

Scroll to navigation

Code::TidyAll::Plugin::PodChecker(3) User Contributed Perl Documentation Code::TidyAll::Plugin::PodChecker(3)

NAME

Code::TidyAll::Plugin::PodChecker - Use podchecker with tidyall

VERSION

version 0.84

SYNOPSIS

   In configuration:
   ; Check for errors, but ignore warnings
   ;
   [PodChecker]
   select = lib/**/*.{pm,pod}
   ; Die on level 1 warnings (can also be set to 2)
   ;
   [PodChecker]
   select = lib/**/*.{pm,pod}
   warnings = 1

DESCRIPTION

Runs podchecker, a POD validator, and dies if any problems were found.

INSTALLATION

Install podchecker from CPAN.

    cpanm podchecker

CONFIGURATION

This plugin accepts the following configuration options:

warnings

The level of warnings to consider as errors - 1 or 2. By default, warnings will be ignored.

SUPPORT

Bugs may be submitted at <https://github.com/houseabsolute/perl-code-tidyall/issues>.

SOURCE

The source code repository for Code-TidyAll can be found at <https://github.com/houseabsolute/perl-code-tidyall>.

AUTHORS

  • Jonathan Swartz <swartz@pobox.com>
  • Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 - 2023 by Jonathan Swartz.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

The full text of the license can be found in the LICENSE file included with this distribution.

2024-03-08 perl v5.40.0