haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a "when in Rome..." clause to the formatting doc.

This commit is contained in:
Jeff Young 2020-04-13 21:28:19 +01:00
parent 6e800bddae
commit e93684015c
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Documentation/development/coding-style-policy.md
View File

@ -596,7 +596,14 @@ is exposed in the header file, merely by including that one header
file. file.
# 7. I Wrote X Lines of Code Before I Read This Document # {#x_lines} # 7. When in Rome... #
Anywhere there are multiple acceptable options, follow the formatting
elsewhere in the same file.
If you encounter a situation that has no guidance, follow the formatting
elsewhere in the same file.
# 8. I Wrote X Lines of Code Before I Read This Document # {#x_lines}
It's OK. We all make mistakes. Fortunately, KiCad provides a It's OK. We all make mistakes. Fortunately, KiCad provides a
configuration file for the code beautifier uncrustify. Uncrustify won't configuration file for the code beautifier uncrustify. Uncrustify won't
fix your naming problems but it does a pretty decent job of formatting fix your naming problems but it does a pretty decent job of formatting
@ -610,7 +617,7 @@ uncrustify [website][uncrustify] for more information.
[uncrustify]: http://uncrustify.sourceforge.net/ [uncrustify]: http://uncrustify.sourceforge.net/
# 8. Show Me an Example # {#show_me_an_example} # 9. Show Me an Example # {#show_me_an_example}
Nothing drives the point home like an example. The source file richio.h Nothing drives the point home like an example. The source file richio.h
below was taken directly from the KiCad source. below was taken directly from the KiCad source.
@ -869,7 +876,7 @@ below was taken directly from the KiCad source.
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
# 9. Resources # {#resources} # 10. Resources # {#resources}
There are plenty of excellent resources on the Internet on C++ coding There are plenty of excellent resources on the Internet on C++ coding
styles and coding do's and don'ts. Here are a few useful ones. In most styles and coding do's and don'ts. Here are a few useful ones. In most
cases, the coding styles do not follow the KiCad coding style but there cases, the coding styles do not follow the KiCad coding style but there