Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix korean grammar rules for '에요/예요' #891

Merged
merged 1 commit into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/ko/reference/array/differenceBy.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function differenceBy<T, U>(firstArr: T[], secondArr: U[], mapper: (value: T | U

- `firstArr` (`T[]`): 차이를 계산할 배열이에요. 이 배열이 주 배열이고, 이 배열의 요소들이 비교되고 필터링돼요.
- `secondArr` (`U[]`): 첫 번째 배열에서 제외할 요소들을 포함한 배열이에요.
- `mapper` (`(value: T | U) => unknown`): 두 배열의 요소들을 매핑할 함수에요. 이 함수는 두 배열의 각 요소에 적용되며, 매핑된 값들을 기준으로 비교를 해요.
- `mapper` (`(value: T | U) => unknown`): 두 배열의 요소들을 매핑할 함수예요. 이 함수는 두 배열의 각 요소에 적용되며, 매핑된 값들을 기준으로 비교를 해요.

### 반환 값

Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/array/differenceWith.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function differenceWith<T, U>(firstArr: T[], secondArr: U[], areItemsEqual: (x:

- `firstArr` (`T[]`): 차이를 계산할 배열이에요. 이 배열이 주 배열이고, 이 배열의 요소들이 비교되고 필터링돼요.
- `secondArr` (`U[]`) : 첫 번째 배열에서 제외할 요소들을 포함한 배열이에요.
- `areItemsEqual` (`(x: T, y: U) => boolean`): 두 요소가 동일한지 결정할 함수에요.
- `areItemsEqual` (`(x: T, y: U) => boolean`): 두 요소가 동일한지 결정할 함수예요.

### 반환 값

Expand Down
4 changes: 2 additions & 2 deletions docs/ko/reference/array/fill.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ function fill<T, U>(array: T[], value: T, start: number, end: number): Array<T |

- `array` (`Array<T | U>`): 채울 배열이에요.
- `value` (`U`): 배열을 채울 값이에요.
- `start` (`number`, 기본값 = 0): 시작 위치에요. 기본값은 0이에요.
- `end` (`number`, 기본값 = array.length): 끝 위치에요. 기본값은 배열의 길이에요.
- `start` (`number`, 기본값 = 0): 시작 위치예요. 기본값은 0이에요.
- `end` (`number`, 기본값 = array.length): 끝 위치예요. 기본값은 배열의 길이예요.

### 반환 값

Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/array/flatMap.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ function flatMap<T, U, D extends number = 1>(arr: T[], iteratee: (item: T) => U,
### 파라미터

- `arr` (`T[]`): 평탄화할 중첩 배열이에요.
- `iteratee` (`T[]`): 각 배열 요소를 매핑하는 함수에요.
- `iteratee` (`T[]`): 각 배열 요소를 매핑하는 함수예요.
- `depth` (`D`): 평탄화할 깊이에요. 기본값은 1이에요.

### 반환 값
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/array/flatMapDeep.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ function flattenDeep<T>(arr: T[]): Array<ExtractNestedArrayType<T>>;
### 파라미터

- `arr` (`T[]`): 평탄화할 중첩 배열이에요.
- `iteratee` (`T[]`): 각 배열 요소를 매핑하는 함수에요.
- `iteratee` (`T[]`): 각 배열 요소를 매핑하는 함수예요.

### 반환 값

Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/array/flatten.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ function flatten<T, D extends number = 1>(arr: T[], depth?: D): Array<FlatArray<
### 파라미터

- `arr` (`T[]`): 평탄화할 중첩 배열이에요.
- `depth` (`D`): 평탄화할 깊이에요. 기본값은 1이에요.
- `depth` (`D`): 평탄화할 깊이예요. 기본값은 1이에요.

### 반환 값

Expand Down
6 changes: 3 additions & 3 deletions docs/ko/reference/array/head.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ const firstElement1 = head(arr1);

const arr2: string[] = [];
const firstElement2 = head(arr2);
// firstElement2는 undefined에요.
// firstElement2는 undefined예요.

const arr3 = ['a', 'b', 'c'];
const firstElement3 = head(arr3);
// firstElement3는 'a'이에요.
// firstElement3는 'a'예요.

const arr4 = [true, false, true];
const firstElement4 = head(arr4);
// firstElement4는 true에요.
// firstElement4는 true예요.

const arr5: [number, string, boolean] = [1, 'a', true];
const firstElement5 = head(arr5);
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/array/isSubsetWith.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function isSubsetWith<T>(superset: T[], subset: T[], areItemsEqual: (x: T, y: T)

- `superset` (`T[]`): 하위 집합의 모든 요소를 포함 할 수 있는 배열이에요.
- `subset` (`T[]`): 상위 집합 배열에 포함되어 있는지 비교 할 배열이에요.
- `areItemsEqual` (`(x: T, y: T) => boolean`): 두 요소가 동일한지 결정할 함수에요.
- `areItemsEqual` (`(x: T, y: T) => boolean`): 두 요소가 동일한지 결정할 함수예요.

### 반환 값

Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/array/last.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ const result = last(arr1);

const arr2: number[] = [];
const result = last(arr2);
// result는 undefined에요.
// result는 undefined예요.

const largeArray = Array(1000)
.fill(0)
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/array/sample.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function sample<T>(arr: T[]): T;

### 반환 값

(`T`): 배열에서 무작위로 선택된 요소에요.
(`T`): 배열에서 무작위로 선택된 요소예요.

## 예시

Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/array/sampleSize.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export function sampleSize<T>(array: T[], size: number): T[];
### 파리미터

- `array` (`T[]`): 샘플링할 배열이에요.
- `size` (`number`): 샘플링할 크기에요.
- `size` (`number`): 샘플링할 크기예요.

### 반환 값

Expand Down
4 changes: 2 additions & 2 deletions docs/ko/reference/compat/array/first.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ const firstElement1 = first(arr1);

const arr2: string[] = [];
const firstElement2 = first(arr2);
// firstElement2는 undefined에요.
// firstElement2는 undefined예요.

const arr3 = ['a', 'b', 'c'];
const firstElement3 = first(arr3);
// firstElement3는 'a'이에요.
// firstElement3는 'a'예요.

const arr4 = [true, false, true];
const firstElement4 = first(arr4);
Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/compat/array/join.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ lodash와 완전히 호환되도록 `join` 함수는 `array`를 다음과 같이

:::

- `separator` (`string`) - 요소를 결합하는 데 사용하는 구분자. 기본값은 쉼표(,)에요.
- `separator` (`string`) - 요소를 결합하는 데 사용하는 구분자. 기본값은 쉼표(,)예요.

### 반환 값

Expand Down
4 changes: 2 additions & 2 deletions docs/ko/reference/compat/math/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ function add(value: number, other: number): number;

### 파라미터

- `value` (`number`): 더할 첫 번째 숫자에요.
- `other` (`number`): 더할 두 번째 숫자에요.
- `value` (`number`): 더할 첫 번째 숫자예요.
- `other` (`number`): 더할 두 번째 숫자예요.

### 반환 값

Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/compat/math/ceil.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
`es-toolkit/compat`에서 이 함수를 가져오면, [lodash와 완전히 똑같이 동작](../../../compatibility.md)해요.
:::

숫자를 지정된 자릿수로 올림하는 함수에요.
숫자를 지정된 자릿수로 올림하는 함수예요.

## 인터페이스

Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/compat/math/floor.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
`es-toolkit/compat`에서 이 함수를 가져오면, [lodash와 완전히 똑같이 동작](../../../compatibility.md)해요.
:::

숫자를 지정된 자릿수로 내림하는 함수에요.
숫자를 지정된 자릿수로 내림하는 함수예요.

## 인터페이스

Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/compat/predicate/isArrayLikeObject.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

주어진 값이 원시값이 아닌 유사 배열 객체인지 확인해요.

유사 배열 객체는 `null`이나 `undefined`나 함수가 아니며, `length` 프로퍼티가 유효한 길이인 객체에요.
유사 배열 객체는 `null`이나 `undefined`나 함수가 아니며, `length` 프로퍼티가 유효한 길이인 객체예요.

TypeScript의 타입 가드로 사용할 수 있어요. 파라미터로 주어진 값의 타입을 `ArrayLike<unknown> & object`로 좁혀요.

Expand Down
4 changes: 2 additions & 2 deletions docs/ko/reference/function/curryRight.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ function curryRight(func: (...args: any[]) => any): (...args: any[]) => any;

### 파라미터

- `func` (`(...args: any[]) => any`): 커리할 함수에요.
- `func` (`(...args: any[]) => any`): 커리할 함수예요.

### 반환 값

(`(...args: any[]) => any`): 커리된 함수에요.
(`(...args: any[]) => any`): 커리된 함수예요.

## 예시

Expand Down
4 changes: 2 additions & 2 deletions docs/ko/reference/math/clamp.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# clamp

숫자를 최솟값과 최댓값의 범위 내로 고정하는 함수에요.
숫자를 최솟값과 최댓값의 범위 내로 고정하는 함수예요.

이 함수는 숫자와 두 개의 경계를 받아서, 지정된 범위 내에서 고정된 숫자를 반환해요.
하나의 경계만 제공되면, 값과 경계 중 최솟값을 반환해요.
Expand All @@ -14,7 +14,7 @@ function clamp(value: number, minimum: number, maximum: number): number;

### 파라미터

- `value` (`number`): 고정할 숫자에요.
- `value` (`number`): 고정할 숫자예요.
- `minimum` (`number`): 숫자를 고정할 최솟값이에요.
- `maximum` (`number`): 숫자를 고정할 최댓값이에요.

Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/math/mean.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# mean

숫자 배열의 평균을 계산하는 함수에요. 빈 배열에 대해서는 `NaN`을 반환해요.
숫자 배열의 평균을 계산하는 함수예요. 빈 배열에 대해서는 `NaN`을 반환해요.

## 인터페이스

Expand Down
4 changes: 2 additions & 2 deletions docs/ko/reference/math/meanBy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# meanBy

`getValue` 함수가 반환하는 값을 기준으로, 숫자 배열의 평균을 계산하는 함수에요.
`getValue` 함수가 반환하는 값을 기준으로, 숫자 배열의 평균을 계산하는 함수예요.

빈 배열에 대해서는 `NaN`을 반환해요.

Expand All @@ -13,7 +13,7 @@ export function meanBy<T>(items: T[], getValue: (element: T) => number): number;
### 파라미터

- `items` (`T[]`): 평균을 계산할 숫자 배열이에요.
- `getValue` (`(item: T) => number`): 각 요소에서 숫자 값을 선택하는 함수에요.
- `getValue` (`(item: T) => number`): 각 요소에서 숫자 값을 선택하는 함수예요.

### 반환 값

Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/math/median.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# median

숫자 배열의 중앙값을 계산하는 함수에요.
숫자 배열의 중앙값을 계산하는 함수예요.

중앙값이란 배열을 정렬했을 때 중앙에 위치하는 요소를 말해요.
배열이 홀수 개의 요소를 가진다면, 중앙에 있는 요소를 반환해요.
Expand Down
4 changes: 2 additions & 2 deletions docs/ko/reference/math/medianBy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# medianBy

`getValue` 함수를 각 요소에 적용하여, 요소 배열의 중앙값을 계산하는 함수에요.
`getValue` 함수를 각 요소에 적용하여, 요소 배열의 중앙값을 계산하는 함수예요.

[중앙값](./median.md)이란 배열을 정렬했을 때 중앙에 위치하는 요소를 말해요.
배열이 홀수 개의 요소를 가진다면, 중앙에 있는 요소를 반환해요.
Expand All @@ -17,7 +17,7 @@ export function medianBy<T>(items: T[], getValue: (element: T) => number): numbe
### 파라미터

- `items` (`T[]`): 중앙값을 계산할 배열이에요.
- `getValue` (`(element: T) => number`): 각 요소에서 숫자 값을 선택하는 함수에요.
- `getValue` (`(element: T) => number`): 각 요소에서 숫자 값을 선택하는 함수예요.

### 반환 값

Expand Down
6 changes: 3 additions & 3 deletions docs/ko/reference/math/round.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# round

숫자를 지정된 자릿수로 반올림하는 함수에요.
숫자를 지정된 자릿수로 반올림하는 함수예요.

이 함수는 숫자와 선택적으로 자릿수 값을 받아서, 지정된 소수점 자릿수로 반올림된 숫자를 반환해요.

Expand All @@ -12,8 +12,8 @@ function round(value: number, precision?: number): number;

### 파라미터

- `value` (`number`): 반올림할 숫자에요.
- `precision` (`number`, optional): 반올림할 소수점 자릿수에요. 기본값은 0이에요.
- `value` (`number`): 반올림할 숫자예요.
- `precision` (`number`, optional): 반올림할 소수점 자릿수예요. 기본값은 0이에요.

### 반환 값

Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/math/sum.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# sum

숫자 배열의 합계를 계산하는 함수에요.
숫자 배열의 합계를 계산하는 함수예요.

이 함수는 숫자 배열을 받아서 배열의 모든 요소를 더한 합계를 반환해요.

Expand Down
2 changes: 1 addition & 1 deletion docs/ko/reference/math/sumBy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export function sumBy<T>(items: T[], getValue: (element: T) => number): number;
### 파라미터

- `items` (`T[]`): 합계를 계산할 숫자 배열이에요.
- `getValue` (`(item: T) => number`): 각 요소에서 숫자 값을 선택하는 함수에요.
- `getValue` (`(item: T) => number`): 각 요소에서 숫자 값을 선택하는 함수예요.

### 반환 값

Expand Down
4 changes: 2 additions & 2 deletions docs/ko/reference/object/findKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ function findKey<T extends Record<any, any>>(
### 파라미터

- `obj` (`T extends Record<any, any>`): 탐색할 객체예요.
- `predicate` (`(value: T[keyof T], key: keyof T, obj: T) => boolean`): 객체의 각 값에 대해 실행할 함수에요.
- `predicate` (`(value: T[keyof T], key: keyof T, obj: T) => boolean`): 객체의 각 값에 대해 실행할 함수예요.

### 반환 값

(`keyof T | undefined`): 인자로 받은 함수를 만족하는 첫 번째 요소의 키에요. 함수를 만족하는 요소가 없으면 undefined를 반환해요.
(`keyof T | undefined`): 인자로 받은 함수를 만족하는 첫 번째 요소의 키예요. 함수를 만족하는 요소가 없으면 undefined를 반환해요.

## 예시

Expand Down
Loading