Changes between Version 50 and Version 51 of Coding_Conventions

Timestamp:

Aug 16, 2020, 12:45:45 PM (4 years ago)

Author:

Nescio

Comment:

add link to English style guide; minor formatting

Coding_Conventions

@@ -14 +14 @@
 
 == Common ==
-
-- Use the US variant of English when choosing variable names. For example, use 'color' instead of 'colour'.
+ * Use the US variant of English when choosing variable names. For example, use 'color' instead of 'colour'. See also the [[EnglishStyleGuide#Englishspelling|English style guide]].
 
 
@@ -252 +251 @@
 
 
-=== Misc ===
+=== Miscellaneous ===
  * In header files, avoid `#include` and use forward declarations wherever possible.
 
@@ -430 +429 @@
 
 
-== JSON==
-* Basically follow the JS formatting conventions
-* When on the same line, insert spaces after `{`, and `:` and before `}`, but not after `[` or before `]`; e.g. `{ "foo": "bar" }` and `["foo", "bar"]`
-* Use tabs for indentation, not spaces
+== JSON ==
+ * Basically follow the JS formatting conventions.
+ * When on the same line, insert spaces after `{`, and `:` and before `}`, but not after `[` or before `]`; e.g. `{ "foo": "bar" }` and `["foo", "bar"]`.
+ * Use tabs for indentation, not spaces.
 
 
@@ -439 +438 @@
  * All XML files should start with
 {{{
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="UTF-8"?>
 }}}
    and be UTF-8 encoded (preferably without a BOM but that doesn't really matter).
-
  * Empty-element tags should be written without a trailing space: use `<foo/>` or `<foo bar="baz"/>`, not `<foo />` nor `<foo bar="baz" />`.
-
  * Indent using whatever the similar existing XML files use. (Usually two spaces; sometimes four spaces, or tabs, etc.)
 
@@ -464 +461 @@
 }}}
  * File extensions for shaders:
-    * `.fs` - fragment shader
-    * `.vs` - vertex shader
-    * `.gs` - geometry shader
-    * `.cs` - compute shader
+   * `.fs` - fragment shader
+   * `.vs` - vertex shader
+   * `.gs` - geometry shader
+   * `.cs` - compute shader
  * All GLSL files should start with right [[https://www.khronos.org/opengl/wiki/Core_Language_(GLSL)#Version|version]].
 {{{