Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Make naming conventions consistent #109
Since conventions are arbitrary, I do not have strong opinions about which are best; I think we should pick whatever is most common in the community and be consistent. We use a mix of naming styles. Consider the DFK constructor:
This mixes lowercase (rundir), lowercase with underscores (lazy_fail, fail_retries), and mixed case (appCache, checkpointFiles). I've seen a few cases of users making mistakes because they mixed up naming styles, so I think that even though it would require some existing user workflows to be updated, it might be worth it to move to a consistent style (and do so ASAP to minimize disruption). PEP-8 discourages mixedCase, so I vote we stick to: ClassName, ExceptionName, GLOBAL_CONSTANT_NAME, and lowercase_with_underscores for everything else.
I vaguely remember discussing this and I think we're already all in agreement, but I wanted to open an issue to keep track of this.