module-build-general

[Module-build-general] [DOC PATCH] contains_pod

[Dave R. <au...@ur...>]

It's pretty handy, might as well document it.

-dave

/*=======================
House Absolute Consulting
www.houseabsolute.com
=======================*/


Index: lib/Module/Build.pm
===================================================================
RCS file: /cvsroot/module-build/Module-Build/lib/Module/Build.pm,v
retrieving revision 1.91
diff -u -r1.91 Build.pm
--- lib/Module/Build.pm 25 Jul 2003 14:17:34 -0000      1.91
+++ lib/Module/Build.pm 28 Jul 2003 21:31:35 -0000
@@ -802,6 +802,11 @@
 The arguments may be either a scalar or an array reference of file
 names.

+=item contains_pod($file)
+
+Returns true if the given file appears contains a line beginning with
+'=pod', '=head', or '=item'.
+
 =back

 =head1 ACTIONS

Re: [Module-build-general] [DOC PATCH] contains_pod

[Ken W. <ke...@ma...>]

On Monday, July 28, 2003, at 04:32  PM, Dave Rolsky wrote:
> --- lib/Module/Build.pm 25 Jul 2003 14:17:34 -0000      1.91
> +++ lib/Module/Build.pm 28 Jul 2003 21:31:35 -0000
> @@ -802,6 +802,11 @@
>  The arguments may be either a scalar or an array reference of file
>  names.
>
> +=item contains_pod($file)
> +
> +Returns true if the given file appears contains a line beginning with
> +'=pod', '=head', or '=item'.
> +

I think you forgot something in the middle there.  Here's how I'm 
patching:

--- lib/Module/Build.pm	25 Jul 2003 14:17:34 -0000	1.91
+++ lib/Module/Build.pm	29 Jul 2003 02:23:35 -0000
@@ -802,6 +802,13 @@
  The arguments may be either a scalar or an array reference of file
  names.

+=item contains_pod($file)
+
+Returns true if the given file appears to contain POD documentation.
+Currently this checks whether the file has a line beginning with
+'=pod', '=head', or '=item', but the exact semantics may change in the
+future.
+
  =back

-Ken