Skip to content

Commit ad10b93

Browse files
Module-Metadata-1.000037
- add decode_pod option for automatic =encoding handling
1 parent 435a294 commit ad10b93

File tree

3 files changed

+21
-14
lines changed

3 files changed

+21
-14
lines changed

CONTRIBUTING

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,4 +104,4 @@ request to the .mailmap file to contain the correct mapping.
104104

105105

106106
This file was generated via Dist::Zilla::Plugin::GenerateFile::FromShareDir 0.014
107-
from a template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.148.
107+
from a template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.150.

Changes

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Revision history for Module-Metadata
22

3-
{{$NEXT}}
3+
1.000037 2019-09-07 18:32:44Z
44
- add decode_pod option for automatic =encoding handling
55

66
1.000036 2019-04-18 18:25:15Z

README.pod

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Module::Metadata - Gather package and POD information from perl module files
88

99
=head1 VERSION
1010

11-
version 1.000036
11+
version 1.000037
1212

1313
=head1 SYNOPSIS
1414

@@ -32,7 +32,7 @@ in the CPAN toolchain.
3232

3333
=head1 CLASS METHODS
3434

35-
=head2 C<< new_from_file($filename, collect_pod => 1) >>
35+
=head2 C<< new_from_file($filename, collect_pod => 1, decode_pod => 1) >>
3636

3737
Constructs a C<Module::Metadata> object given the path to a file. Returns
3838
undef if the filename does not exist.
@@ -45,7 +45,10 @@ If the file begins by an UTF-8, UTF-16BE or UTF-16LE byte-order mark, then
4545
it is skipped before processing, and the content of the file is also decoded
4646
appropriately starting from perl 5.8.
4747

48-
=head2 C<< new_from_handle($handle, $filename, collect_pod => 1) >>
48+
Alternatively, if C<decode_pod> is set, it will decode the collected pod
49+
sections according to the C<=encoding> declaration.
50+
51+
=head2 C<< new_from_handle($handle, $filename, collect_pod => 1, decode_pod => 1) >>
4952

5053
This works just like C<new_from_file>, except that a handle can be provided
5154
as the first argument.
@@ -58,15 +61,15 @@ mandatory or undef will be returned.
5861
You are responsible for setting the decoding layers on C<$handle> if
5962
required.
6063

61-
=head2 C<< new_from_module($module, collect_pod => 1, inc => \@dirs) >>
64+
=head2 C<< new_from_module($module, collect_pod => 1, inc => \@dirs, decode_pod => 1) >>
6265

6366
Constructs a C<Module::Metadata> object given a module or package name.
6467
Returns undef if the module cannot be found.
6568

66-
In addition to accepting the C<collect_pod> argument as described above,
67-
this method accepts a C<inc> argument which is a reference to an array of
68-
directories to search for the module. If none are given, the default is
69-
@INC.
69+
In addition to accepting the C<collect_pod> and C<decode_pod> arguments as
70+
described above, this method accepts a C<inc> argument which is a reference to
71+
an array of directories to search for the module. If none are given, the
72+
default is @INC.
7073

7174
If the file that contains the module begins by an UTF-8, UTF-16BE or
7275
UTF-16LE byte-order mark, then it is skipped before processing, and the
@@ -237,7 +240,7 @@ assistance from David Golden (xdg) <[email protected]>.
237240

238241
=head1 CONTRIBUTORS
239242

240-
=for stopwords Karen Etheridge David Golden Vincent Pit Matt S Trout Chris Nehren Graham Knop Olivier Mengué Tomas Doran tokuhirom Christian Walde Tatsuhiko Miyagawa Peter Rabbitson Steve Hay Jerry D. Hedden Craig A. Berry Mitchell Steinbrunner Edward Zborowski Gareth Harper James Raspass 'BinGOs' Williams Josh Jore Kent Fredric
243+
=for stopwords Karen Etheridge David Golden Vincent Pit Matt S Trout Chris Nehren Tomas Doran Olivier Mengué Graham Knop tokuhirom Tatsuhiko Miyagawa Christian Walde Leon Timmermans Peter Rabbitson Steve Hay Jerry D. Hedden Craig A. Berry Mitchell Steinbrunner Edward Zborowski Gareth Harper James Raspass 'BinGOs' Williams Josh Jore Kent Fredric
241244

242245
=over 4
243246

@@ -263,27 +266,31 @@ Chris Nehren <[email protected]>
263266

264267
=item *
265268

266-
Graham Knop <[email protected]>
269+
Tomas Doran <[email protected]>
267270

268271
=item *
269272

270273
Olivier Mengué <[email protected]>
271274

272275
=item *
273276

274-
Tomas Doran <[email protected]>
277+
Graham Knop <[email protected]>
275278

276279
=item *
277280

278281
tokuhirom <[email protected]>
279282

280283
=item *
281284

285+
Tatsuhiko Miyagawa <[email protected]>
286+
287+
=item *
288+
282289
Christian Walde <[email protected]>
283290

284291
=item *
285292

286-
Tatsuhiko Miyagawa <[email protected]>
293+
Leon Timmermans <[email protected]>
287294

288295
=item *
289296

0 commit comments

Comments
 (0)