chore: remove types from jsdoc

mljs · Feb 14, 2024 · 5bfdb39 · 5bfdb39
1 parent 388b93f
commit 5bfdb39
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/src/createTree.ts b/src/createTree.ts
@@ -37,10 +37,12 @@ export interface CreateTreeOptions {
 
 /**
  * Function that creates the tree
- * @return { Tree | null }
  */
 
-export function createTree(dataXY: DataXY, options: CreateTreeOptions = {}) {
+export function createTree(
+  dataXY: DataXY,
+  options: CreateTreeOptions = {},
+): Tree | null {
   const { x, y } = dataXY;
   const {
     minWindow = 0.16,

diff --git a/src/treeSimilarity.ts b/src/treeSimilarity.ts
@@ -8,13 +8,13 @@ export interface TreeSimilarityOptions {
 
 /**
  * Similarity between two nodes
- * @return {number} similarity measure between tree nodes
+ * @return similarity measure between tree nodes
  */
 export function treeSimilarity(
   treeA: Tree | null,
   treeB: Tree | null,
   options: TreeSimilarityOptions = {},
-) {
+): number {
   const { alpha = 0.1, beta = 0.33, gamma = 0.001 } = options;
 
   if (treeA === null || treeB === null) {