Skip to content

Commit ce46217

Browse files
jsparkdevseokju-na
andauthored
docs: update types in all codeblocks (#79)
Co-authored-by: seokju-na <seokju.me@toss.im>
1 parent ffc0f58 commit ce46217

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+185
-185
lines changed

docs/ko/reference/Commit/Methods/body.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git 커밋 메시지의 긴 "본문"을 가져와요.
88

99
```ts
1010
class Commit {
11-
body(): string;
11+
body(): string | null;
1212
}
1313
```
1414

@@ -30,4 +30,4 @@ class Commit {
3030
<br>
3131
<p class="param-description">올바른 utf-8이 아닐 경우 에러를 발생시켜요.</p>
3232
</li>
33-
</ul>
33+
</ul>

docs/ko/reference/Commit/Methods/summary.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git 커밋 메시지의 간단한 "요약"을 가져와요.
88

99
```ts
1010
class Commit {
11-
summary(): string;
11+
summary(): string | null;
1212
}
1313
```
1414

@@ -30,4 +30,4 @@ class Commit {
3030
<br>
3131
<p class="param-description">올바른 UTF-8 인코딩이 아닐 경우 에러를 발생시켜요.</p>
3232
</li>
33-
</ul>
33+
</ul>

docs/ko/reference/Diff/Methods/findSimilar.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ diff 파일 내에서 파일 리네임, 복사 등을 반영하도록 변환해
88

99
```ts
1010
class Diff {
11-
findSimilar(options?: DiffFindOptions): void;
11+
findSimilar(options?: DiffFindOptions | null | undefined): void;
1212
}
1313
```
1414

@@ -117,4 +117,4 @@ class Diff {
117117
</li>
118118
</ul>
119119
</li>
120-
</ul>
120+
</ul>

docs/ko/reference/Diff/Methods/print.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
```ts
88
class Diff {
9-
print(options?: DiffPrintOptions | null): string;
9+
print(options?: DiffPrintOptions | null | undefined): string;
1010
}
1111
```
1212

@@ -35,4 +35,4 @@ class Diff {
3535
<br>
3636
<p class="param-description">포맷팅된 출력 값을 반환해요.</p>
3737
</li>
38-
</ul>
38+
</ul>

docs/ko/reference/Index/Methods/addAll.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
```ts
88
class Index {
9-
addAll(pathspecs: string[], options?: IndexAddAllOptions): void;
9+
addAll(pathspecs: string[], options?: IndexAddAllOptions | null | undefined): void;
1010
}
1111
```
1212

@@ -68,4 +68,4 @@ const repo = await openRepository('.');
6868
const index = repo.index();
6969
index.addAll(['*']);
7070
index.write();
71-
```
71+
```

docs/ko/reference/Index/Methods/getByPath.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
```ts
88
class Index {
9-
getByPath(path: string, stage?: IndexStage): IndexEntry | null;
9+
getByPath(path: string, stage?: IndexStage | null | undefined): IndexEntry | null;
1010
}
1111
```
1212

@@ -85,4 +85,4 @@ class Index {
8585
</li>
8686
</ul>
8787
</li>
88-
</ul>
88+
</ul>

docs/ko/reference/Index/Methods/read.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
```ts
88
class Index {
9-
read(force?: boolean): void;
9+
read(force?: boolean | null | undefined): void;
1010
}
1111
```
1212

@@ -18,4 +18,4 @@ class Index {
1818
<br>
1919
<p class="param-description">만약 <code>true</code>로 설정되면, 메모리상의 변경 사항을 모두 버리고 항상 디스크상의 인덱스 데이터를 다시 로드하는 강제 읽기를 수행해요. 디스크상에 version 데이터가 없으면 인덱스는 초기화돼요. <code>false</code>면, 마지막 로드 이후에 디스크상의 데이터가 변경되었을 경우에만 인덱스 데이터를 재로딩하는 소프트 읽기를 수행해요. 메모리상의 순수 데이터는 그대로 유지돼요. 주의할 점은, 디스크에 변경 사항이 있을 경우 메모리상의 기록되지 않은 변경 사항은 버려진다는 거예요.</p>
2020
</li>
21-
</ul>
21+
</ul>

docs/ko/reference/Index/Methods/removeAll.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
```ts
88
class Index {
9-
removeAll(pathspecs: string[], options?: IndexRemoveAllOptions): void;
9+
removeAll(pathspecs: string[], options?: IndexRemoveAllOptions | null | undefined): void;
1010
}
1111
```
1212

@@ -30,4 +30,4 @@ class Index {
3030
</li>
3131
</ul>
3232
</li>
33-
</ul>
33+
</ul>

docs/ko/reference/Index/Methods/removePath.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
```ts
1010
class Index {
11-
removePath(path: string, options?: IndexRemoveOptions): void;
11+
removePath(path: string, options?: IndexRemoveOptions | null | undefined): void;
1212
}
1313
```
1414

@@ -32,4 +32,4 @@ class Index {
3232
</li>
3333
</ul>
3434
</li>
35-
</ul>
35+
</ul>

docs/ko/reference/Index/Methods/setVersion.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
```ts
88
class Index {
9-
setVersion(version: number): number;
9+
setVersion(version: number): void;
1010
}
1111
```
1212

@@ -18,4 +18,4 @@ class Index {
1818
<br>
1919
<p class="param-description">유효한 값은 2, 3 또는 4예요. 만약 2가 주어지면, 인덱스를 정확하게 표현하기 위해 필요한 경우 git_index_write가 버전 3의 인덱스를 기록할 수도 있어요.</p>
2020
</li>
21-
</ul>
21+
</ul>

0 commit comments

Comments
 (0)