Skip to content

Naming convention exception generating/deriving formats #1445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 23, 2019
Merged

Naming convention exception generating/deriving formats #1445

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions _style/naming-conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ Classes should be named in upper camel case:

This mimics the Java naming convention for classes.

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

## Objects

Object names are like class names (upper camel case).
Expand Down