Last active
August 1, 2019 15:09
-
-
Save kwakwaversal/f962ba2e842f2895d7681818f31e9adb to your computer and use it in GitHub Desktop.
POD outline for a distribution (you should cherry pick suitable headings and paragraphs) #perl #boilerplate
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| package MyDistribution::SomeModule; | |
| 1; | |
| __END__ | |
| =encoding utf8 | |
| =head1 NAME | |
| MyDistribution::SomeModule - Some short description | |
| =head1 SYNOPSIS | |
| use MyDistribution::SomeModule; | |
| my $m = MyDistribution::SomeModule->new; | |
| # hello world! | |
| say "hello world!"; | |
| # To get a development version up and running | |
| $ carton install --deployment --cached | |
| $ carton exec morbo script/irh | |
| Server available at http://127.0.0.1:3000 | |
| =head1 DESCRIPTION | |
| L<MyDistribution::SomeModule> is a bla bla. | |
| =head1 ATTRIBUTES | |
| L<MyDistribution::SomeModule> implements the following attributes. | |
| L<MyDistribution::SomeModule> inherits all attributes from L<Mojo::Base> and | |
| implements the following new ones. | |
| =head2 foo | |
| =head1 METHODS | |
| L<MyDistribution::SomeModule> implements the following methods. | |
| L<MyDistribution::SomeModule> inherits all methods from L<Mojo::Base> and | |
| implements the following new ones. | |
| =head2 bar | |
| =head1 OPERATORS | |
| L<MyDistribution::SomeModule> overloads the following operators. | |
| =head2 bool | |
| my $bool = !!$cookie; | |
| Always true. | |
| =head2 stringify | |
| my $str = "$cookie"; | |
| Alias for L</"to_string">. | |
| =head1 CREDITS | |
| In alphabetical order: | |
| =over 2 | |
| My Name | |
| =back | |
| =head1 COPYRIGHT | |
| Copyright (C) 2017, My Name. | |
| =head1 COPYRIGHT AND LICENSE | |
| Copyright (C) 2017, My Name and others. | |
| This program is free software, you can redistribute it and/or modify it under | |
| the terms of the Artistic License version 2.0. | |
| =head1 SEE ALSO | |
| L<MyDistribution>. | |
| =cut |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment