From 2df38fe4e26c9231f3dac1decde259d6060572ad Mon Sep 17 00:00:00 2001 From: jgjgill <79239852+jgjgill@users.noreply.github.com> Date: Mon, 17 Jun 2024 12:26:32 +0900 Subject: [PATCH] docs(isUndefined): Polish document styles and fix incorrect comments (#67) * docs: add inline code markdown * fix: change to undefined[] annotation * Revert "fix: change to undefined[] annotation" This reverts commit 3b81b8fb8a40c597eb5cd00fe66388d0c965e6e5. * chore: recommit --- docs/ko/reference/predicate/isUndefined.md | 6 +++--- docs/reference/predicate/isUndefined.md | 6 +++--- src/predicate/isUndefined.spec.ts | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/ko/reference/predicate/isUndefined.md b/docs/ko/reference/predicate/isUndefined.md index 73848281..28984d0a 100644 --- a/docs/ko/reference/predicate/isUndefined.md +++ b/docs/ko/reference/predicate/isUndefined.md @@ -1,6 +1,6 @@ # isUndefined -주어진 값이 undefined인지 확인해요. +주어진 값이 `undefined`인지 확인해요. 이 함수는 주어진 값이 `undefined` 인지 엄격 일치 (===) 기준으로 확인합니다. 값이 `undefined` 이면 `true`, 아니면 `false` 를 반환해요. @@ -15,11 +15,11 @@ function isUndefined(x: unknown): x is undefined; ### 파라미터 -- `x` (`unknown`): undefined인지 확인할 값 +- `x` (`unknown`): `undefined`인지 확인할 값 ### 반환 값 -(`x is undefined`): 값이 undefined이면 true, 아니면 false. +(`x is undefined`): 값이 `undefined`이면 `true`, 아니면 `false`. ## 예시 diff --git a/docs/reference/predicate/isUndefined.md b/docs/reference/predicate/isUndefined.md index ad8fcca8..0aa1c09f 100644 --- a/docs/reference/predicate/isUndefined.md +++ b/docs/reference/predicate/isUndefined.md @@ -1,6 +1,6 @@ # isUndefined -Checks if the given value is undefined. +Checks if the given value is `undefined`. This function tests whether the provided value is strictly equal to `undefined`. It returns `true` if the value is `undefined`, and `false` otherwise. @@ -15,11 +15,11 @@ function isUndefined(x: unknown): x is undefined; ### Parameters -- `x` (`unknown`): The value to test if it is undefined. +- `x` (`unknown`): The value to test if it is `undefined`. ### Returns -(`x is undefined`): True if the value is undefined, false otherwise. +(`x is undefined`): `true` if the value is `undefined`, `false` otherwise. ## Examples diff --git a/src/predicate/isUndefined.spec.ts b/src/predicate/isUndefined.spec.ts index 25c0f009..943be236 100644 --- a/src/predicate/isUndefined.spec.ts +++ b/src/predicate/isUndefined.spec.ts @@ -17,7 +17,7 @@ describe('isUndefined', () => { const result = arr.filter(isUndefined); - // Here the type of result should be `null[]`. + // Here the type of result should be `undefined[]`. expect(result).toStrictEqual([undefined]); }); });