submodules naming convention

[scroll]

Feature description Naming convention of submodules

Extra information Currently the repository consists of different style naming conventions:

simpleRig (camelcase) maya-math-nodes (dashes) mgear_core (underscores)

Would you like to standardize it? I personally prefer dashes or underscores, because everything becomes lowercase and easier to guess.

[RafaelVillar]

Dashes, underscores are discouraged. https://www.python.org/dev/peps/pep-0008/?#package-and-module-names https://stackoverflow.com/questions/711884/python-naming-conventions-for-modules

I agree we should standardize it, but with as much pep8 as possible.

[miquelcampos]

yep good point. Some repos are forked like the maya-math-nodes. So not sure the best way to standardize. But this names are only the name of the repo. Not the module itself. Again, not sure about this distintion. but this is how it looks the modules in the final release:

I guess only simpleRig is a clear revision needed.

What do you think?

[scroll]

@miquelcampos , in the upper example shifter_classic_components has underscores, is it going to be there in the future or? For forked repos, I feel we can still change the container directory, I think.

[miquelcampos]

@scroll That was my original ideal. To keep the underscore separation to help readability.

In this specific situation the module is a package of components for shifter. So I thought make sense to have a very long descriptive name .

For example in the future we can have more like this: shifter_mechanical_components shifter_bird_components shifter_projectXXX_componets shifter_youNameIt_components

But I am really open to suggestions and better solutions :)

[jdrese]

Hello guys

Following this topic really quickly I think that for me simpleRig should be changed to simplerig and shifter_classic_components could simply by shiftercomponents and then having the specific ones under that same module with a simpler name. Maybe we could even create factory or builin module inside shiftercomponents which stores the ones that get shipped by mGear team officially but I am not a supper fan of the idea. I think we could simple have shiftercomponents and then everything inside as it is and the way we categorize them is by creating a category property that allows later on shifter to classify thing. But work but we should try to avoid super long cascading modules names (3 or 4 max)