Re: Help with naming: ASDoc to POD conversion

2005-08-10 Thread James E Keenan 

Chris Dolan wrote:
I am working on a module that converts Flash Actionscript  documentation 
(an informal variant of Javadoc) to POD.  What would be  a good name for 
this?


I like to Pod:: namespace, but that's mostly for modules that convert  
from POD, not to POD.  One exception is Pod::HTML2Pod, which leads me  
to one option:


  Pod::ASDoc2Pod



Sounds good to me.

jimk

Re: Help with naming: ASDoc to POD conversion

2005-08-10 Thread Chris Dolan 

On Aug 10, 2005, at 12:28 AM, A. Pagaltzis wrote:


* Chris Dolan [EMAIL PROTECTED] [2005-08-09 17:05]:


I like to Pod:: namespace, but that's mostly for modules that
convert  from POD, not to POD.  One exception is Pod::HTML2Pod,
which leads me  to one option:

  Pod::ASDoc2Pod


[snip]


I do think the Pod:: namespace is appropriate for this. The
primary purpose of the module has to do with POD, so that’s where
it should be filed.

I don’t like the 2Pod bit – both for the (common and established;
unfortunately) abuse of “2” just to save a character as well as
because the “to POD” part really is redundant. What you want is a
simple “From.”

I also think the “AS” acronym is way too opaque for this. I’m not
sure it needs to mention “Doc,” though “Javadoc” would be too
much.

So I’d say this module’s name is

Pod::FromActionScriptDoc

or if you think it’s unambiguous enough, maybe

Pod::FromActionScript

both of which are plain, descriptive and memorable.


Thanks much, Aristotle!  I like your latter suggestion and will go  
with that.


Chris
--
Chris Dolan, Software Developer, Clotho Advanced Media Inc.
608-294-7900, fax 294-7025, 1435 E Main St, Madison WI 53703

Clotho Advanced Media, Inc. - Creators of MediaLandscape Software  
(http://www.media-landscape.com/) and partners in the revolutionary  
Croquet project (http://www.opencroquet.org/)