isaacscript-common 1.2.286 → 1.2.287

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -123,7 +123,16 @@ export declare function printConsole(msg: string): void;
123
123
  * ```
124
124
  */
125
125
  export declare function repeat(n: int, func: (i: int) => void): void;
126
- /** Helper function to prevent early returns from being deleted by ESLint. */
126
+ /**
127
+ * Helper function to signify that the enclosing code block is not yet complete. Using this function
128
+ * is similar to writing a "TODO" comment, but it has the benefit of preventing early returns from
129
+ * being automatically deleted by ESLint.
130
+ *
131
+ * When you see this function, it simply means that the programmer intends to add in more code to
132
+ * this spot later.
133
+ *
134
+ * This function does not actually do anything. (It is an "empty" function.)
135
+ */
127
136
  export declare function todo(): void;
128
137
  /**
129
138
  * Helper function to check every value of a custom enum for -1. This is helpful as a run-time check
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "isaacscript-common",
3
- "version": "1.2.286",
3
+ "version": "1.2.287",
4
4
  "description": "Helper functions for IsaacScript mods",
5
5
  "keywords": [
6
6
  "isaac",