improve compose method doc

eclipsesource · Jun 12, 2024 · 0f7c99f · 0f7c99f
1 parent 80a0701
commit 0f7c99f
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/packages/core/src/util/path.ts b/packages/core/src/util/path.ts
@@ -28,11 +28,11 @@ import range from 'lodash/range';
 import { isScoped, Scopable } from '../models';
 
 /**
- * Composes two JSON pointer. Pointer1 is appended to pointer2.
- * JSON pointer is seperated and start with '/' e.g: /foo/0
+ * Composes two JSON pointer. Pointer2 is appended to pointer1.
+ * Example: pointer1 `'/foo/0'` and pointer2 `'/bar'` results in `'/foo/0/bar'`.
  *
- * @param {string} pointer1 JSON pointer
- * @param {string} pointer2 JSON pointer
+ * @param {string} pointer1 Initial JSON pointer
+ * @param {string} pointer2 JSON pointer to append to `pointer1`
  * @returns {string} resulting JSON pointer
  */
 export const compose = (pointer1: string, pointer2: string) => {