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(ja): update Japanese docs (08/17/2024 ~ 09/21/2024) #1924

Merged
merged 5 commits into from
Oct 25, 2024

Conversation

yoshi2no
Copy link
Contributor

@yoshi2no yoshi2no commented Sep 21, 2024

Changes

I have updated the Japanese documentation that had not been updated, based on the changes made to the English documentation between August 17th, when the Japanese documentation was added #1855 , and September 21st.

I'm not sure if all updates were caught, but I identified the files updated during the specified period using the following method and updated the differences.

git log --since="2024-08-17" --name-only --pretty=format: -- docs/**/*.md | sort | uniq

docs/cli.md
docs/examples.md
docs/ja/migration-guide.md // Already updated
docs/migration-guide.md // Already updated
docs/openapi-fetch/api.md

How to Review

I’m thinking of asking @siketyan to review if there are any inappropriate expressions.

Checklist

  • Unit tests updated
  • docs/ updated (if necessary)
  • pnpm run update:examples run (only applicable for openapi-typescript)

@yoshi2no yoshi2no requested a review from a team as a code owner September 21, 2024 08:23
Copy link

changeset-bot bot commented Sep 21, 2024

⚠️ No Changeset found

Latest commit: 60dc0b8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@@ -180,6 +181,15 @@ const { data, error } = await client.PUT("/submit", {
});
```

::: tip

便宜上、 `openapi-fetch` は `body` パラメーターに値が指定されたリクエストに対して、`Content-Type` を自動的に `application/json` に設定します。

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just an idea to avoid duplicated "に"

Suggested change
便宜上、 `openapi-fetch``body` パラメーターに値が指定されたリクエストに対して、`Content-Type` を自動的に `application/json` に設定します
便宜上、 `openapi-fetch``body` パラメーターに値が指定されたリクエストに対して、`Content-Type` `application/json` に自動で設定します

if (typeof status === "number") {
// status >= 400
} else if (api.isAxiosError(error)) {
// リクエスト失敗(例:ネットワークエラー

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nits

Suggested change
// リクエスト失敗(例:ネットワークエラー
// リクエスト失敗(例:ネットワークエラー


// 例1. "axios"(デフォルト)のステータス処理方法での使用 (validStatus: 'axios')

// axiosのようにエラーを投げる(例:status >= 400、ネットワークエラー、インターセプターエラー)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO "エラーを投げる" sounds slightly casual, "スローする" is used widely than the former.

Suggested change
// axiosのようにエラーを投げる(例:status >= 400、ネットワークエラー、インターセプターエラー)
// axiosのようにエラーをスローする(例:status >= 400、ネットワークエラー、インターセプターエラー)

@yoshi2no
Copy link
Contributor Author

@siketyan

Applied review suggestions, thanks for the quick review!

Copy link
Contributor

@drwpow drwpow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the improvements! 🙏

@drwpow drwpow merged commit 08b537b into openapi-ts:main Oct 25, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants