search

Bryn-Mawr-Plasma-Laboratory / bmplib

Home for all BMPL related code
2 stars 14 forks source link

Naming Scheme #3

Open cacsphysics opened 4 years ago

cacsphysics commented 4 years ago

@dschaffner Which naming scheme should the bmplib package use? I like the mixedCase and the _lower_case_withunderscores.

This way there is consistency within the package.

dschaffner commented 4 years ago

I think we should make it similar to PlasmaPy and/or bapsflib. Maybe @rocco8773 can chime in here?

rocco8773 commented 4 years ago

You're a python package, so I'd follow PEP8 naming conventions.

dschaffner commented 4 years ago

Right, but I think what Carlos is asking is about which naming convention to actually use. The link you sent seems to suggest there are different variations. What is the variation you and Nick tend to use?

rocco8773 commented 4 years ago

PEP8 naming conventions for classes are CamelCase, functions are lowercase_with_underscores (same goes for variables and methods), constants are CAPITALS_WITH_UNDERSCORES, etc. If you look through PEP8 it has naming specifications for each type.