Skip to content
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.

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

Document and enforce Distribution-Name and Module::Name conventions [rt.cpan.org #66606] #30

Open
xsawyerx opened this issue Jan 5, 2015 · 1 comment

Comments

@xsawyerx
Copy link
Owner

xsawyerx commented Jan 5, 2015

https://rt.cpan.org/Ticket/Display.html?id=66606

Andy,

I've really enjoyed this module since finding it a few years ago.

Even with many years in the Perl community, I wasn't sure how to name
pass arguments to this.  I was so module-centric in my thinking that I
didn't (fully) know what a distribution was.  I had conflated them in my
mind.

I think it would be great to give example command-line examples with
real-world (not symbolic) arguments.

Simple, 1-module distribution:

module-maker --distro=MyCompany-DBI --module=MyCompany::DBI
  equivalent to:
module-maker --module=MyCompany::DBI

More complex, multi-module distribution:

module-maker --distro=MyCompany::Communication
--module=MyCompany::Communication::HTTP,MyCompany::Communication::FTP,MyCompany::Communication::Paper,MyCompany::Communication::Paper::CottonBond,MyCompany::Communication::Paper::HempFiber

In addition, doing a quick naming-convention check (with appropriate
errors) would be helpful and instructive to newbies (and not-so-newbies
like me).

If you like this idea enough to approve it, but don't have time to code
it, let me know.  I'd be happy to submit patches.

Thanks,
Michael
@xsawyerx
Copy link
Owner Author

xsawyerx commented Jan 5, 2015

MichaelRWolf@att.net - 2011-03-15 17:15:59

On Mon Mar 14 18:20:11 2011, MichaelRWolf@att.net wrote:

Andy,

I've really enjoyed this module since finding it a few years ago.

[...]

I guess this is a big deal for me. I did an AnnoCPAN entry over a year
ago....

http://www.annocpan.org/~PETDANCE/Module-Starter-1.54/lib/Module/Starter.pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant