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

Code Formatting: general variable name conventions #37

Open
nimrod46 opened this issue Apr 13, 2020 · 0 comments
Open

Code Formatting: general variable name conventions #37

nimrod46 opened this issue Apr 13, 2020 · 0 comments
Assignees
Labels
help wanted Extra attention is needed

Comments

@nimrod46
Copy link
Member

We need to define first what every significant value name should be.

  1. "Breathing cycle", I don't like this name as someone reading the code could be confused with the other meaning of the word breath. So I suggest respiration_cycle.
  2. "loop cycle" using cycle again does not seem right as someone who is less familiar with this software or in general with how code works will most likely think it's about the respiration cycle (it can be confusing for everyone actually as point 1 and 2 have quite a lot of variables, confused me too).
    I suggest using update, update_time, update_lost, time_since_last_update, etc' just not mentioning the word cycle.
  3. "index", used to describe the current step in the "motion profile" profile, so I suggest using respiration_step, maybe respiration_step_index because it's used as an index after all.

@ElectricRCAircraftGuy tell me what you think on those points, there are more general variables to add here as well I guess.

@nimrod46 nimrod46 added the help wanted Extra attention is needed label Apr 13, 2020
@ElectricRCAircraftGuy ElectricRCAircraftGuy changed the title Code Formatting: general veriable name conventions Code Formatting: general variable name conventions Apr 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants