From 0f7c99f905a55f2cbb7b4e8874ec14b4552ec295 Mon Sep 17 00:00:00 2001 From: Lucas Koehler Date: Wed, 12 Jun 2024 12:47:36 +0200 Subject: [PATCH] improve compose method doc --- packages/core/src/util/path.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/core/src/util/path.ts b/packages/core/src/util/path.ts index 2dde224f7..afbb93da3 100644 --- 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) => {