Skip to content
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.

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

Update style guide to denote correct case style #37

Open
glemieux opened this issue May 8, 2023 · 0 comments
Open

Update style guide to denote correct case style #37

glemieux opened this issue May 8, 2023 · 0 comments
Labels
correction Corrections to existing grammar, spelling, context, etc developer pertaining to the developer's guide

Comments

@glemieux
Copy link
Collaborator

glemieux commented May 8, 2023

Description

The current documentation notes that we use CamelCase, but what we actually use by definition is PascalCase (where we to use the former we would use camelCase).

Suggested fix

Correct the style guide to note that we use PascalCase. Also update the guide to note that the use of underscores in variable names is snake_case. It looks like we also use camelCase for derived type naming (e.g. currentSite) which seems like a good distinction to keep between objects and variables.

@glemieux glemieux added correction Corrections to existing grammar, spelling, context, etc developer pertaining to the developer's guide labels May 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction Corrections to existing grammar, spelling, context, etc developer pertaining to the developer's guide
Projects
None yet
Development

No branches or pull requests

1 participant