Ticket #1194: Bad.pm

File Bad.pm, 4.8 KB (added by bowtie, 4 years ago)
Line 
1package Bad;
2
3use warnings;
4use strict;
5use Carp;
6
7use version; our $VERSION = qv('0.0.3');
8
9
10# Other recommended modules (uncomment to use):
11#  use IO::Prompt;
12#  use Perl6::Export;
13#  use Perl6::Slurp;
14#  use Perl6::Say;
15
16
17# Module implementation here
18
19
201; # Magic true value required at end of module
21__END__
22
23=head1 NAME
24
25Bloggs3 - [One line description of module's purpose here]
26
27=head1 VERSION
28
29This document describes Bloggs3 version 0.0.1
30
31
32=head1 SYNOPSIS
33
34    use Bloggs3;
35
36=for author to fill in:
37    Brief code example(s) here showing commonest usage(s).
38    This section will be as far as many users bother reading
39    so make it as educational and exeplary as possible.
40 
41 
42=head1 DESCRIPTION
43
44=for author to fill in:
45    Write a full description of the module and its features here.
46    Use subsections (=head2, =head3) as appropriate.
47
48
49=head1 INTERFACE
50
51=for author to fill in:
52    Write a separate section listing the public components of the modules
53    interface. These normally consist of either subroutines that may be
54    exported, or methods that may be called on objects belonging to the
55    classes provided by the module.
56
57
58=head1 DIAGNOSTICS
59
60=for author to fill in:
61    List every single error and warning message that the module can
62    generate (even the ones that will "never happen"), with a full
63    explanation of each problem, one or more likely causes, and any
64    suggested remedies.
65
66=over
67
68=item C<< Error message here, perhaps with %s placeholders >>
69
70[Description of error here]
71
72=item C<< Another error message here >>
73
74[Description of error here]
75
76[Et cetera, et cetera]
77
78=back
79
80
81=head1 CONFIGURATION AND ENVIRONMENT
82
83=for author to fill in:
84    A full explanation of any configuration system(s) used by the
85    module, including the names and locations of any configuration
86    files, and the meaning of any environment variables or properties
87    that can be set. These descriptions must also include details of any
88    configuration language used.
89 
90Bloggs3 requires no configuration files or environment variables.
91
92
93=head1 DEPENDENCIES
94
95=for author to fill in:
96    A list of all the other modules that this module relies upon,
97    including any restrictions on versions, and an indication whether
98    the module is part of the standard Perl distribution, part of the
99    module's distribution, or must be installed separately. ]
100
101None.
102
103
104=head1 INCOMPATIBILITIES
105
106=for author to fill in:
107    A list of any modules that this module cannot be used in conjunction
108    with. This may be due to name conflicts in the interface, or
109    competition for system or program resources, or due to internal
110    limitations of Perl (for example, many modules that use source code
111    filters are mutually incompatible).
112
113None reported.
114
115
116=head1 BUGS AND LIMITATIONS
117
118=for author to fill in:
119    A list of known problems with the module, together with some
120    indication Whether they are likely to be fixed in an upcoming
121    release. Also a list of restrictions on the features the module
122    does provide: data types that cannot be handled, performance issues
123    and the circumstances in which they may arise, practical
124    limitations on the size of data sets, special cases that are not
125    (yet) handled, etc.
126
127No bugs have been reported.
128
129Please report any bugs or feature requests to
130C<bug-bloggs3@rt.cpan.org>, or through the web interface at
131L<http://rt.cpan.org>.
132
133
134=head1 AUTHOR
135
136admin  C<< <admin@bowtie.org> >>
137
138
139=head1 LICENCE AND COPYRIGHT
140
141Copyright (c) 2011, admin C<< <admin@bowtie.org> >>. All rights reserved.
142
143This module is free software; you can redistribute it and/or
144modify it under the same terms as Perl itself. See L<perlartistic>.
145
146
147=head1 DISCLAIMER OF WARRANTY
148
149BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
150FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
151OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
152PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
153EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
154WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
155ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
156YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
157NECESSARY SERVICING, REPAIR, OR CORRECTION.
158
159IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
160WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
161REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
162LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
163OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
164THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
165RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
166FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
167SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
168SUCH DAMAGES.