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

API is not consistent, there is snake cases and camel case functions #90

Open
patrickelectric opened this issue Mar 20, 2020 · 2 comments · May be fixed by #123
Open

API is not consistent, there is snake cases and camel case functions #90

patrickelectric opened this issue Mar 20, 2020 · 2 comments · May be fixed by #123
Milestone

Comments

@patrickelectric
Copy link
Member

transmitAngle vs transmit_frequency

@jaxxzer
Copy link
Member

jaxxzer commented Apr 14, 2020

The pattern that I have been using is that variables or functions from ping-protocol messages are done with snake case to match the ping-protocol docs and definitions, this also helps simplify templates. Other things that include extra logic like helper functions to form the api are done with camel case (according to our guidelines). I think it is the same pattern in ping viewer?

here is a link for quick ref https://docs.bluerobotics.com/ping-python/classbrping_1_1ping360_1_1Ping360.html

I agree it's a strange situation, but I don't know if it's a problem.

@ES-Alexander ES-Alexander added this to the 0.2.0 milestone Dec 2, 2021
@ES-Alexander ES-Alexander linked a pull request Mar 20, 2022 that will close this issue
17 tasks
@ES-Alexander
Copy link
Contributor

We've decided that language conventions are worth following over a blanket style across all languages, so this can get changed to consistently use snake_case as per PEP8. Breaking APIs is still bad, so unless this is paired with a non-style-based major breaking change it should likely maintain the old calling code as well (perhaps with a deprecation warning).

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.

3 participants