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

Consistent naming conventions #12

Closed
akissinger opened this issue May 9, 2023 · 3 comments · Fixed by #24
Closed

Consistent naming conventions #12

akissinger opened this issue May 9, 2023 · 3 comments · Fixed by #24
Assignees

Comments

@akissinger
Copy link
Member

akissinger commented May 9, 2023

For consistency (and generally not getting weird-looking code), I suggest we adopt PEP 8 naming conventions where ever possible/reasonable:

https://peps.python.org/pep-0008/#naming-conventions

The main exception to this is the Qt bindings, which are all C++ style. The accepted convention is to use Python naming for your own code and Qt conventions just for calling/overriding Qt things.

In particular, capital letters and underscores should (almost) never go together. This looks very strange to me.

Also, I suggest avoiding writing the type of a thing in variable names, e.g. the many variables called Button_..... The exception to this is if there is only one thing of a given type around, e.g. a graph_view of type GraphView.

@mark-koch
Copy link
Collaborator

Hey, I could have a go at this if no one has started working on it yet? I wanted to go over everything anyways to get to know the codebase

@devilkiller-ag
Copy link

Hey, Can I also work on this?

@natestemen
Copy link

@jvdwetering @akissinger please ensure @mark-koch is assigned to this issue when you get a chance to we can ensure he is awarded the bounty!

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

Successfully merging a pull request may close this issue.

4 participants