-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
unclear coding standard examples #536
Comments
I think the problem is bigger then just this one. Why do we have N ways? Acceptable, Discouraged, Correct, Preferred, In the past if you choose to do it the any way other then Preferred, your contribution would be modified to be the Preferred way. This sort of thing is what makes having or creating a formatting tool a complex mess for NO ADDED value. Why not remove all the ambiguity from the fix the CS document and fix the tool? |
We should carefully entertain any PR to modify the coding standard. Remember that the version in Confluence is NOT the master. The master is in the nuttx repository at Documents/NuttXCCCodingStandard.html and can be updated via PR as with any other file. The verion on Confluence is then a copy of that. Any changes made in Confluence will be lost the next time that the Documents are updated. |
@patacongo good to know - Should we add this note to the repo so that that never happens? |
It is true of all of the documents under the documents tabs. These are only copies. The really should just be read-only |
NuttXCCodingStandard.html lists the following examples in both of "Preferred" and "Acceptable".
The text was updated successfully, but these errors were encountered: