diff options
author | James E Keenan <jkeenan@cpan.org> | 2016-02-07 07:58:29 -0500 |
---|---|---|
committer | James E Keenan <jkeenan@cpan.org> | 2016-02-09 18:32:02 -0500 |
commit | f94c6c536844091ca6a005e3e0398db8e1cc212e (patch) | |
tree | f925a605fe031a7bd5a1144b3733059303c4f016 | |
parent | be467f9538c4793cb78ccd9b0ea18d98faae50e3 (diff) | |
download | perl-f94c6c536844091ca6a005e3e0398db8e1cc212e.tar.gz |
Update guidance on naming of modules.
Delete reference to comp.lang.perl.misc. Add references to module-authors
list/newsgroup and to PAUSE.
For: RT # 127435
-rw-r--r-- | pod/perlmodlib.PL | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/pod/perlmodlib.PL b/pod/perlmodlib.PL index 608b64e7ea..aa6b18cd3c 100644 --- a/pod/perlmodlib.PL +++ b/pod/perlmodlib.PL @@ -1223,7 +1223,6 @@ Module names should begin with a capital letter. Having 57 modules all called Sort will not make life easy for anyone (though having 23 called Sort::Quick is only marginally better :-). Imagine someone trying to install your module alongside many others. -If in any doubt ask for suggestions in comp.lang.perl.misc. If you are developing a suite of related modules/classes it's good practice to use nested classes with a common prefix as this will @@ -1244,6 +1243,12 @@ To be portable each component of a module name should be limited to 11 characters. If it might be used on MS-DOS then try to ensure each is unique in the first 8 characters. Nested modules make this easier. +For additional guidance on the naming of modules, please consult: + + http://pause.perl.org/pause/query?ACTION=pause_namingmodules + +or send mail to the <module-authors@perl.org> mailing list. + =item * Have you got it right? @@ -1253,8 +1258,9 @@ picked an interface design that will cause problems later? Have you picked the most appropriate name? Do you have any questions? The best way to know for sure, and pick up many helpful suggestions, -is to ask someone who knows. Comp.lang.perl.misc is read by just about -all the people who develop modules and it's the best place to ask. +is to ask someone who knows. The <module-authors@perl.org> mailing list +is useful for this purpose; it's also accessible via news interface as +perl.module-authors at nntp.perl.org. All you need to do is post a short summary of the module, its purpose and interfaces. A few lines on each of the main methods is |