Skip to content

Commit 64f1f2d

Browse files
author
rob
committed
2 parents f06895a + 8c3240b commit 64f1f2d

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ In general, we try and follow the original texts: [PEP 8](https://peps.python.or
6262

6363
### Naming conventions
6464

65-
- I prefer mixedCase to CamelCase.
65+
- For classes, I prefer mixedCase to CamelCase, but single word names should always be Camels.
6666
- Common methods are `get`, `calculate`, `read`, `write`.
6767
- There is a specific procedure for naming objects which form part of the data heirarchy, see [here](https://github.com/robcarver17/pysystemtrade/blob/master/docs/data.md#part-2-overview-of-futures-data-in-pysystemtrade). If this is not followed, then the [automated abstraction of data inside Data 'blob' instances](https://github.com/robcarver17/pysystemtrade/blob/master/docs/data.md#data-blobs) won't work.
6868
- Although arguably redundant, I am a fan of describing eg objects that inherit from dicts with a dict_ prefix. This gives hints as to how they behave without having to look at their code.

0 commit comments

Comments
 (0)