Skip to content

Commit a4eddf1

Browse files
authored
Naming convention exception generating/deriving formats
1 parent 8625f61 commit a4eddf1

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

_style/naming-conventions.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ Classes should be named in upper camel case:
4040

4141
This mimics the Java naming convention for classes.
4242

43+
Sometimes traits and classes as well as their members are used to describe
44+
formats, documentation or protocols and generate/derive them.
45+
In these cases it is desirable to be close to a 1:1 relation to the output format
46+
and the naming conventions don't apply. In this case, they should only be used
47+
for that specific purpose and not throughout the rest of the code.
48+
4349
## Objects
4450

4551
Object names are like class names (upper camel case).

0 commit comments

Comments
 (0)