Skip to content

fix up the doco #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
plicease merged 1 commit into from
Nov 14, 2025
Merged

fix up the doco #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ Test2 check that all of your Perl files are tidy
# DESCRIPTION

This module lets you test your code for tidiness. It is more or less a drop in replacement
for [Test::PerlTidy](https://metacpan.org/pod/Test::PerlTidy), except that it is implemented using [Test2::API](https://metacpan.org/pod/Test2::API), and it handles
UTF-8 (a common encoding for Perl source code) better, and works on windows.
for [Test::PerlTidy](https://metacpan.org/pod/Test::PerlTidy), except that it is implemented using [Test2::API](https://metacpan.org/pod/Test2::API). The [is\_file\_tidy](https://metacpan.org/pod/is_file_tidy)
function mentioned below also takes an option `return_diff_object` below that did not exist
in the original.

# FUNCTIONS

Expand Down
5 changes: 3 additions & 2 deletions lib/Test2/Tools/PerlTidy.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ our @EXPORT_OK = qw( run_tests is_file_tidy );
=head1 DESCRIPTION

This module lets you test your code for tidiness. It is more or less a drop in replacement
for L<Test::PerlTidy>, except that it is implemented using L<Test2::API>, and it handles
UTF-8 (a common encoding for Perl source code) better, and works on windows.
for L<Test::PerlTidy>, except that it is implemented using L<Test2::API>. The L<is_file_tidy>
function mentioned below also takes an option C<return_diff_object> below that did not exist
in the original.

=head1 FUNCTIONS

Expand Down
Loading