fix: formatting and tsdoc

conda · Feb 20, 2025 · 4c66f15 · 4c66f15
1 parent 81de8ee
commit 4c66f15
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/js-rattler/.prettierrc b/js-rattler/.prettierrc
@@ -3,5 +3,6 @@
     "semi": true,
     "trailingComma": "all",
     "useTabs": false,
-    "plugins": ["prettier-plugin-jsdoc"]
+    "plugins": ["prettier-plugin-jsdoc"],
+    "tsdoc": true
 }
diff --git a/js-rattler/src/Version.ts b/js-rattler/src/Version.ts
@@ -205,7 +205,9 @@ export class Version {
     /**
      * Compare two versions.
      *
-     * Returns `-1` if this < other, `0` if this == other, `1` if this > other
+     * Returns `-1` if this instance should be ordered before `other`, `0` if
+     * this version and `other` are considered equal, `1` if this version should
+     * be ordered after `other`.
      */
     public compare(other: Version): number {
         return this.native.compare(other.native);