Document the lowerCamelCase in a comment

See: hhvm#517 (comment)
lexidor · Sep 19, 2022 · 2c3e996 · 2c3e996
1 parent 23a6da8
commit 2c3e996
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/__Private/LintRunConfig.hack b/src/__Private/LintRunConfig.hack
@@ -15,6 +15,7 @@ use type Facebook\HHAST\Linter;
 
 final class LintRunConfig {
 
+  // Use `lowerCamelCase` for shape key names.
   const type TOverride = shape(
     // Which files this override applies to (uses `fnmatch()`)
     'patterns' => vec<string>,
@@ -26,6 +27,9 @@ final class LintRunConfig {
     ?'disableAllLinters' => bool,
     ?'linterConfigs' => dict<string, dynamic>,
   );
+
+  // Use `lowerCamelCase` for shape key names.
+  // The configuration file uses `lowerCamelCase` and being consistent is preferred.
   const type TConfigFile = shape(
     // Where to lint, eg '[ "src/", "codegen/", "tests/" ]
     'roots' => vec<string>,