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: don't use long same-line comments; use the line above #33

Open
ElectricRCAircraftGuy opened this issue Apr 13, 2020 · 2 comments

Comments

@ElectricRCAircraftGuy
Copy link
Collaborator

This is a sub-issue of #11. Don't close #11 until all sub-issues are resolved.

I will help with this; just want to teach the principle too is all.

Instead of:

#define insp_pressure_default 40  // defualt value - hold this pressure while breathing - the value is changed if INSP_Pressure
                                  // potentiometer is inatalled

Do:

/// Default value - hold this pressure while breathing - the value is changed if 
/// INSP_Pressure potentiometer is installed
#define INSP_PRESSURE_DEFAULT 40

Notice I also add doxygen comments ///, and change the constant to all caps. Limit your max column width, or "ruler" as it is frequently called, to 100 chars.

@ElectricRCAircraftGuy
Copy link
Collaborator Author

The clang-format autoformatter really doesn't like these long lines. You'll see once I get it pushed. See the email I sent you @nimrod46 and @giorakor so I can know how you want me to push changes.

@ElectricRCAircraftGuy
Copy link
Collaborator Author

PR #46 resolves a tiny portion of this issue

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

1 participant