docs: unify optional parameter translation#1502
Open
jjamming wants to merge 3 commits intoreactjs:mainfrom
Open
docs: unify optional parameter translation#1502jjamming wants to merge 3 commits intoreactjs:mainfrom
jjamming wants to merge 3 commits intoreactjs:mainfrom
Conversation
Replace **optional**, **선택사항**, **선택 사항**, **(선택사항)**, **(선택적)** label variants with the agreed `identifier`**(선택사항)** form per issue reactjs#1478. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…#1478) Replace **optional**, **선택 사항** label variants with the agreed `identifier`**(선택사항)** form per issue reactjs#1478. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR standardizes how optional parameters are labeled in reference documentation, unifying the mixed optional/선택사항 variants into the agreed format: `identifier`**(선택사항)**:.
Changes:
- Replaces inconsistent optional markers (e.g.,
**optional**,**선택사항**,**(선택적)**) with`...`**(선택사항)**:across React/React DOM reference docs. - Aligns optional labeling for nested option objects (e.g.,
optionsand its fields) to the same convention. - Applies the convention to both parameter lists and return-value lists where applicable.
Reviewed changes
Copilot reviewed 29 out of 29 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| src/content/reference/react/useSyncExternalStore.md | Standardizes optional parameter label for getServerSnapshot. |
| src/content/reference/react/useReducer.md | Standardizes optional parameter label for init. |
| src/content/reference/react/useLayoutEffect.md | Standardizes optional label for dependencies entries. |
| src/content/reference/react/useInsertionEffect.md | Standardizes optional label for dependencies. |
| src/content/reference/react/useImperativeHandle.md | Standardizes optional label for dependencies. |
| src/content/reference/react/useEffect.md | Standardizes optional label formatting for dependencies. |
| src/content/reference/react/useDeferredValue.md | Standardizes optional label for initialValue. |
| src/content/reference/react/useDebugValue.md | Standardizes optional label for format. |
| src/content/reference/react/useActionState.md | Standardizes optional label for permalink. |
| src/content/reference/react/memo.md | Standardizes optional label for arePropsEqual. |
| src/content/reference/react/createElement.md | Standardizes optional label for ...children. |
| src/content/reference/react/cloneElement.md | Standardizes optional label for ...children. |
| src/content/reference/react/ViewTransition.md | Standardizes optional labels for props and callbacks. |
| src/content/reference/react/Fragment.md | Standardizes optional labels for key/ref props. |
| src/content/reference/react/Component.md | Standardizes optional labels for callback parameters. |
| src/content/reference/react/Children.md | Standardizes optional labels for thisArg. |
| src/content/reference/react-dom/static/resumeAndPrerenderToNodeStream.md | Standardizes optional labels for options and its fields. |
| src/content/reference/react-dom/static/resumeAndPrerender.md | Standardizes optional labels for options and its fields. |
| src/content/reference/react-dom/static/prerenderToNodeStream.md | Standardizes optional labels for options and its fields. |
| src/content/reference/react-dom/static/prerender.md | Standardizes optional labels for options and its fields. |
| src/content/reference/react-dom/server/resumeToPipeableStream.md | Standardizes optional labels for options and its fields. |
| src/content/reference/react-dom/server/resume.md | Standardizes optional labels for options and its fields. |
| src/content/reference/react-dom/server/renderToString.md | Standardizes optional labels for options and its fields. |
| src/content/reference/react-dom/server/renderToStaticMarkup.md | Standardizes optional labels for options and its fields. |
| src/content/reference/react-dom/server/renderToReadableStream.md | Standardizes optional labels for options and its fields. |
| src/content/reference/react-dom/server/renderToPipeableStream.md | Standardizes optional labels for options and its fields. |
| src/content/reference/react-dom/components/common.md | Standardizes optional label for the returned cleanup function. |
| src/content/reference/react-dom/client/hydrateRoot.md | Standardizes optional labels for options and its fields. |
| src/content/reference/react-dom/client/createRoot.md | Standardizes optional labels for options and its fields. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| * `value`: 지연시키려는 값입니다. 모든 타입을 가질 수 있습니다. | ||
| * **선택사항** `initialValue`: 컴포넌트 초기 렌더링 시 사용할 값입니다. 이 옵션을 생략하면 초기 렌더링 동안 `useDeferredValue`는 값을 지연시키지 않습니다. 이는 대신 렌더링할 `value`의 이전 버전이 없기 때문입니다. | ||
| * `initialValue`**(선택사항)**: 컴포넌트 초기 렌더링 시 사용할 값입니다. 이 옵션을 생략하면 초기 렌더링 동안 `useDeferredValue`는 값을 지연시키지 않습니다. 이는 대신 렌더링할 `value`의 이전 버전이 없기 때문입니다. |
There was a problem hiding this comment.
문서 전반에서 optional 표기 컨벤션을 새로 통일했는데, 이를 강제/가이드할 수 있도록 textlint 용어 사전에도 반영하는 편이 좋겠습니다. Issue #1478에서 언급된 /textlint/data/rules/translateGlossary.js (및 자동 생성되는 /wiki/translate-glossary.md)에 optional 표기(예: "(선택사항)")를 추가해 추후 문서에서 다시 표기가 혼재되지 않게 해 주세요.
Suggested change
| * `initialValue`**(선택사항)**: 컴포넌트 초기 렌더링 시 사용할 값입니다. 이 옵션을 생략하면 초기 렌더링 동안 `useDeferredValue`는 값을 지연시키지 않습니다. 이는 대신 렌더링할 `value`의 이전 버전이 없기 때문입니다. | |
| * `initialValue` (선택사항): 컴포넌트 초기 렌더링 시 사용할 값입니다. 이 옵션을 생략하면 초기 렌더링 동안 `useDeferredValue`는 값을 지연시키지 않습니다. 이는 대신 렌더링할 `value`의 이전 버전이 없기 때문입니다. |
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1478
선택적 매개변수 라벨 통일
AS-IS
등 여러 형태로 혼재되어 있습니다.
TO-BE
`identifier`**(선택사항)**:형식으로 통일합니다.필수 확인 사항
textlint가이드Textlint Guide선택 확인 사항