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

naming convention for classes and functions #25

Open
fnrizzi opened this issue Oct 19, 2023 · 2 comments
Open

naming convention for classes and functions #25

fnrizzi opened this issue Oct 19, 2023 · 2 comments
Assignees

Comments

@fnrizzi
Copy link
Member

fnrizzi commented Oct 19, 2023

  • check if functions and classes have consistent naming (camelcase, or whatnot)
  • make a summary of all the inconsistencies
@cwschilly
Copy link
Collaborator

cwschilly commented Oct 19, 2023

The standard for the repo is:
Classes: PascalCase
Functions: camelCase

This has been formalized in #64


There are some exceptions:

romtools/workflows/dakota/sampling.py

  • line 161: def run_dakota_sampling()

romtools/trial_space_utils/svd_method_of_snapshots.py

  • line 12: def A_transpose_dot_bImpl()
  • line 72: class svdMethodOfSnapshots

romtools/trial_space_utils/outputter.py

  • line 13: def npz_output()
  • line 21: def hdf5_output()
  • line 26: def exodus_output()

@jtencer
Copy link
Contributor

jtencer commented Dec 18, 2023

We decided to switch it to use snake_case for functions to be consistent with PEP8. I updated most things to use that format, but some exceptions remain.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants