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

Translate getting-started.md to Japanese #550

Merged
merged 2 commits into from
Jun 17, 2024

Conversation

K-dash
Copy link
Contributor

@K-dash K-dash commented Jun 14, 2024

Related to #545

  • まずはGetting Startedの日本語版Docを作成しました。

また、インストール可能な追加パッケージの説明として numpy が抜けていると思いましたので英語版Docの方にも追加しています。(認識誤りがありましたらご指摘ください)

Copy link

codecov bot commented Jun 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.04%. Comparing base (971b5ff) to head (8a6fae7).
Report is 25 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #550      +/-   ##
==========================================
- Coverage   91.04%   91.04%   -0.01%     
==========================================
  Files          13       13              
  Lines        1931     1942      +11     
  Branches      431      437       +6     
==========================================
+ Hits         1758     1768      +10     
  Misses        117      117              
- Partials       56       57       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Owner

@yukinarit yukinarit left a comment

Choose a reason for hiding this comment

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

ほぼLGTMです!少しコメントを残しました。確認お願いします

* `toml`:[tomli](https://github.com/hukkin/tomli) と [tomli-w](https://github.com/hukkin/tomli-w) をインストール
* 注記:python 3.11以降は [tomllib](https://docs.python.org/3/library/tomllib.html) を使用
* `yaml`:[pyyaml](https://github.com/yaml/pyyaml) をインストール
* `numpy`:[numpy](https://github.com/numpy/numpy) をインストール
Copy link
Owner

Choose a reason for hiding this comment

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

orjsonsqlalchemyが実は漏れていました。ついでに追加してもらえると助かります 🙇

Copy link
Contributor Author

Choose a reason for hiding this comment

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

追加しました!

8a6fae7

@@ -13,7 +13,7 @@ If you're using poetry, run this command.
poetry add pyserde
```

Additional data formats besides JSON and Pickle need additional dependencies installed. Install `msgpack`, `toml`, or `yaml` extras to work with the appropriate data formats; you can skip formats that you don't plan to use. For example, if you want to use Toml and YAML:
Additional data formats besides JSON and Pickle need additional dependencies installed. Install `msgpack`, `toml`, `yaml` or `numpy` extras to work with the appropriate data formats; you can skip formats that you don't plan to use. For example, if you want to use Toml and YAML:
Copy link
Owner

Choose a reason for hiding this comment

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

numpyはデータフォーマットじゃないので、ここに無くても良さそうです。numpyextrasについては”利用可能な追加パッケージ”のところで説明されていました

Copy link
Contributor Author

Choose a reason for hiding this comment

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

失礼しました。ご指摘の通りです。en/jaどちらも削除しました🙇

8a6fae7

- Remove `numpy` from the list of additional packages needed for data formats.
- Add `orjson` and `sqlalchemy` to the list of extras available with the `all` option.
Copy link
Owner

@yukinarit yukinarit left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@yukinarit yukinarit added the documentation Improvements or additions to documentation label Jun 17, 2024
@yukinarit yukinarit merged commit 8ec44de into yukinarit:main Jun 17, 2024
2 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants