added note regarding auto-generated file

FriendsOfREDAXO · Jun 14, 2022 · 15be429 · 15be429
1 parent 61d8e95
commit 15be429
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/lib/RexStanUserConfig.php b/lib/RexStanUserConfig.php
@@ -5,14 +5,18 @@ final class RexStanUserConfig {
      * @param int   $level
      * @param array<string> $paths
      * @param array<string> $includes
+     *
+     * @return void
      */
     static public function save(int $level, array $paths, array $includes) {
         $file = [];
         $file['includes'] = $includes;
         $file['parameters']['level'] = $level;
         $file['parameters']['paths'] = $paths;
 
-        rex_file::put(self::userconfig(), rex_string::yamlEncode($file, 3));
+        $prefix = "# rexstan auto generated file - do not edit\n\n";
+
+        rex_file::put(self::userconfig(), $prefix . rex_string::yamlEncode($file, 3));
     }
 
     static public function getLevel(): int {