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

READMEにrequireの表記を追加 #3

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

zamami
Copy link

@zamami zamami commented Oct 20, 2023

内容(箇条書き)

『素晴らしいプロダクトに感謝しています。』

  • こうすればより良いと思うこと
    READMEの使い方のコードに以下を追記するのはいかがでしょうか?
require 'faker/japanese`

もしくは、
//Faker::japanese::nameのみ使用する場合
require 'faker/japanese/name`

  • なぜそう思うのか
    使い方のソースコードにrequireの記述を含めた方がユーザーが問題なくfaker-japaneseを使用できるかもしれないと思ったため。
    gem install faker-japaneseを実行後、初学者はどのようにrequireしたらいいのかわからない可能性があるため。
    私自身、require faker-japaneseと記述してしまいloadエラーを起こしてしまったため。

また、今後の実装次第だとは思われますが、
require "faker/japanese/name"
などの方法でfaker-japaneseの部分的な利用が可能だということもREADMEに記述されるのはいかがでしょうか?

環境

OS: mac OS Monterey 12.6.5
Ruby:3.2.2

README.md Outdated
@@ -13,6 +13,8 @@ Faker::Japanese

* フルネーム

require 'faker/japanese`
Copy link

Choose a reason for hiding this comment

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

Suggested change
require 'faker/japanese`
require 'faker/japanese'

(他の文字列リテラルはダブルクォートなのでシングルクォートよりダブルクォートの方がいいかもしれません。)

Copy link
Author

Choose a reason for hiding this comment

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

確認ありがとうございます。
ダブルクォートに修正、requireを追記しました。

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.

2 participants