Re: module name for a tutorial or example or sample module

2012-06-08 Thread Aristotle Pagaltzis
* bulk 88 bul...@hotmail.com [2012-06-08 03:20]:
 It only real purpose is to be copied into other XS modules and be
 studied from. What namespace should it go under?

CopyPasta::FastHash? :-)

In all seriousness, I would pick Example::XS::FasterHashes. Or maybe
just Example::FasterXSHashes.

XS:: seems the wrong place because the *main* thing about this module
seems to me to be that it is not a library, just an educational example
for XS authors.

Module:: is definitely incorrect, because this has nothing to do with
doing something with modules.

Acme:: seems incorrect because to my mind it means “this is stupid or
crazy but in any case inadvisable, yet still funny or cool, and I wanted
to put it out there for people to look at”. And your code would clearly
be out of place in such a category.

Regards,
-- 
Aristotle Pagaltzis // http://plasmasturm.org/


Re: module name for a tutorial or example or sample module

2012-06-08 Thread Zbigniew Łukasiak
On Fri, Jun 8, 2012 at 5:09 PM, Aristotle Pagaltzis pagalt...@gmx.de wrote:
 * bulk 88 bul...@hotmail.com [2012-06-08 03:20]:
 It only real purpose is to be copied into other XS modules and be
 studied from. What namespace should it go under?

 CopyPasta::FastHash? :-)

 In all seriousness, I would pick Example::XS::FasterHashes. Or maybe
 just Example::FasterXSHashes.

 XS:: seems the wrong place because the *main* thing about this module
 seems to me to be that it is not a library, just an educational example
 for XS authors.

 Module:: is definitely incorrect, because this has nothing to do with
 doing something with modules.

 Acme:: seems incorrect because to my mind it means “this is stupid or
 crazy but in any case inadvisable, yet still funny or cool, and I wanted
 to put it out there for people to look at”. And your code would clearly
 be out of place in such a category.


I vote for Example:: - I wish there were more such modules (I would
even move many existing modules into that namespace).

Z.


Re: module name for a tutorial or example or sample module

2012-06-08 Thread M. Nunberg
It's already a common convention for module authors to have an 'eg' 
directory which contains examples.


How about making this into a top level namespace (Generally top level 
namespaces are discouraged, but in this case it might be beneficial and 
encourage other authors to place more robust and visible examples).


Eg::XS::FastHash

or

XS::Eg::FastHash

or

XS::FastHash::Eg


On 06/07/2012 06:14 PM, bulk 88 wrote:


I have a XS module I wrote as a sample, example or tutorial on how to do increase the 
performance of perl hashes on an XS level. It doesn't do anything useful on its own other 
provide 2 XSUBs which are supposed to be benchmarked against each other to show the 
traditional vs my new way of doing things. It exports nothing 
C/.so/.a/.lib/.dll or Perl wise. It's test file just does the benchmark. It doesn't link 
with anything except a stock perl and a stock c std lib. It only real purpose is to be 
copied into other XS modules and be studied from. What namespace should it go under? I 
thought its name should be FastHash or XSFasterHashes. Example::FastHash? Example:: 
already exists. Sample:: doesn't exist. XS:: exists, XS::Example doesn't, so 
XS::Example::FastHash? Module::FastHash? (I dont like that) Module::Example::FastHash? 
Acme::FastHash? Acme::Tutorial::FastHash? I dont find Acme:: offensive, its a good way to 
prove the module doesn't do anything on its own and its not int
ended to 
be use'd.




module name for a tutorial or example or sample module

2012-06-07 Thread bulk 88

I have a XS module I wrote as a sample, example or tutorial on how to do 
increase the performance of perl hashes on an XS level. It doesn't do anything 
useful on its own other provide 2 XSUBs which are supposed to be benchmarked 
against each other to show the traditional vs my new way of doing things. It 
exports nothing C/.so/.a/.lib/.dll or Perl wise. It's test file just does the 
benchmark. It doesn't link with anything except a stock perl and a stock c std 
lib. It only real purpose is to be copied into other XS modules and be studied 
from. What namespace should it go under? I thought its name should be FastHash 
or XSFasterHashes. Example::FastHash? Example:: already exists. Sample:: 
doesn't exist. XS:: exists, XS::Example doesn't, so XS::Example::FastHash? 
Module::FastHash? (I dont like that) Module::Example::FastHash? Acme::FastHash? 
Acme::Tutorial::FastHash? I dont find Acme:: offensive, its a good way to prove 
the module doesn't do anything on its own and its not intended to be use'd.