Improve documentation, see phetsims/chipper#1018

phetsims · Jul 13, 2021 · 2435fac · 2435fac
1 parent 896bf3e
commit 2435fac
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/js/dual/SimVersion.js b/js/dual/SimVersion.js
@@ -4,9 +4,10 @@
  * Handles serializing and deserializing versions for simulations.
  *
  **************************************************************
- * IMPORTANT NOTE: This file is copied from PERENNIAL to CHIPPER frequently. If this is in CHIPPER, then it is AUTO
- * GENERATED; do not edit, as it will be overwritten. Make sure that any change here is supported by usages of
- * CHIPPER's SimVersion (i.e. in JOIST/updateCheck.js), see https://github.com/phetsims/perennial/issues/111 for more
+ * IMPORTANT NOTE: This file is copied from PERENNIAL to CHIPPER frequently.
+ * If this is in CHIPPER, then it is AUTO GENERATED; do not edit, as it will be overwritten.
+ * If this is in PERENNIAL, make sure your changes are compatible with CHIPPER.
+ * See https://github.com/phetsims/perennial/issues/111 and https://github.com/phetsims/chipper/issues/1018
  **************************************************************
  *
  * See https://github.com/phetsims/chipper/issues/560 for discussion on version ID definition.

diff --git a/js/dual/execute.js b/js/dual/execute.js
@@ -3,6 +3,13 @@
 /**
  * Command execution wrapper (with common settings)
  *
+ **************************************************************
+ * IMPORTANT NOTE: This file is copied from PERENNIAL to CHIPPER frequently.
+ * If this is in CHIPPER, then it is AUTO GENERATED; do not edit, as it will be overwritten.
+ * If this is in PERENNIAL, make sure your changes are compatible with CHIPPER.
+ * See https://github.com/phetsims/perennial/issues/111 and https://github.com/phetsims/chipper/issues/1018
+ **************************************************************
+ *
  * @author Jonathan Olson <[email protected]>
  */