Skip to content

Commit d524fe0

Browse files
committed
improve compose method doc
1 parent b603f96 commit d524fe0

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

packages/core/src/util/path.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ import isEmpty from 'lodash/isEmpty';
2727
import range from 'lodash/range';
2828

2929
/**
30-
* Composes two JSON pointer. Pointer1 is appended to pointer2.
31-
* JSON pointer is seperated and start with '/' e.g: /foo/0
30+
* Composes two JSON pointer. Pointer2 is appended to pointer1.
31+
* Example: pointer1 `'/foo/0'` and pointer2 `'/bar'` results in `'/foo/0/bar'`.
3232
*
33-
* @param {string} pointer1 JSON pointer
34-
* @param {string} pointer2 JSON pointer
33+
* @param {string} pointer1 Initial JSON pointer
34+
* @param {string} pointer2 JSON pointer to append to `pointer1`
3535
* @returns {string} resulting JSON pointer
3636
*/
3737
export const compose = (pointer1: string, pointer2: string) => {

0 commit comments

Comments
 (0)