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

Design review: Style Guide #32

Open
krook opened this issue Jul 8, 2021 · 0 comments
Open

Design review: Style Guide #32

krook opened this issue Jul 8, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation firmware

Comments

@krook
Copy link
Member

krook commented Jul 8, 2021

Update code to adhere to a common style guide and automated documentation system.

A consistent style for firmware usually should be enforced for large projects, in order for them to appear consistent. For C, a good template is the Linux style guide, however, it is common to make documented deviations where necessary.

It is also generally best practice that the firmware itself should be documented in a format compatible with auto-documentation tools such as Doxygen.

@krook krook added documentation Improvements or additions to documentation firmware labels Jul 8, 2021
@krook krook added this to To do in Pyrrha Development via automation Jul 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation firmware
Projects
Development

No branches or pull requests

1 participant