diff options
| author | Albert Y <76888457+filterpaper@users.noreply.github.com> | 2023-06-21 10:58:13 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-06-20 20:58:13 -0600 |
| commit | 2f1cac6e9febd6209ff9a012b7fcd03af4f9cb82 (patch) | |
| tree | 4347bb30d7f3efc8b506633a46608e8ced406f46 /docs | |
| parent | 7753249d3d284afcc4b164f808dfaafdd02b3e8c (diff) | |
[Docs] Code markdown amendment (#21323)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/coding_conventions_c.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/coding_conventions_c.md b/docs/coding_conventions_c.md index 3f44da713d..32f6de7ff7 100644 --- a/docs/coding_conventions_c.md +++ b/docs/coding_conventions_c.md @@ -8,8 +8,8 @@ Most of our style is pretty easy to pick up on, but right now it's not entirely * Closing Brace: Lined up with the first character of the statement that opens the block * Else If: Place the closing brace at the beginning of the line and the next opening brace at the end of the same line. * Optional Braces: Always include optional braces. - * Good: if (condition) { return false; } - * Bad: if (condition) return false; + * Good: `if (condition) { return false; }` + * Bad: `if (condition) return false;` * We encourage use of C style comments: `/* */` * Think of them as a story describing the feature * Use them liberally to explain why particular decisions were made. |