Browse Source

[docs] clarify that NoCheckDependencies can be dangerous

skip ci
Simon Krajewski 7 years ago
parent
commit
b3133faa76
1 changed files with 5 additions and 0 deletions
  1. 5 0
      std/haxe/macro/CompilationServer.hx

+ 5 - 0
std/haxe/macro/CompilationServer.hx

@@ -17,6 +17,11 @@ abstract ModuleCheckPolicy(Int) {
 
 	/**
 		Disables dependency checks of the module.
+
+		This should only be used for modules that don't depend on any module that
+		might change. It is effectively a promise to the compiler that the module
+		is unaffected by changes made to other modules. If that promise is broken,
+		the compiler is sad and things probably stop working.
 	**/
 	var NoCheckDependencies = 2;