[mnet-devel] coding standards question: module names

[Zooko]

The Twisted Coding Standard [1] says this about modules:

    """
    Modules

    Modules must be named in all lower-case, preferably short, single words. 
    If a module name contains multiple words, they may be separated by 
    underscores or not separated at all.

    In most cases, modules should contain more than one class, function, or 
    method; if a module contains only one object, consider refactoring to 
    include more related functionality in that module.
    """

Now currently in mnet_new, we usually have modules named the same as the 
"primary" class within that module.  For example, BlockWrangler.py contains 
classes BlockWrangler, BlockWranglerData, ChunkMap, and FileMap.  
BlockWranglingStrategy.py contains classes BlockWranglingStrategy and GSR (and 
hopefully soon KISS?).

If we switched to Twisted module standards, then we would have a single file 
named "blockwrangling" or "blockwrangler" that would contain all those classes.

Is this better?  Is it worth switching?

Regards,

Zooko

[1] http://twistedmatrix.com/documents/howto/coding-standard



-------------------------------------------------------
This SF.NET email is sponsored by:
SourceForge Enterprise Edition + IBM + LinuxWorld = Something 2 See!
http://www.vasoftware.com
_______________________________________________
mnet-devel mailing list
mnet-devel at lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mnet-devel