Rename Faker::show to Faker::Theater#2921
Conversation
|
@stefannibrasil Please review :) |
stefannibrasil
left a comment
stefannibrasil
left a comment
There was a problem hiding this comment.
Thank you! One small ask: could you rewrite the commit message with the details from the original PR:
This Pull Request has been created because of naming issues identified here: https://github.com/faker-ruby/faker/issues/2787
This PR replaces the usage of Faker::Show to be Faker::Theater for the following reasons:
The file was created under faker/music/show.rb but the class definition is Faker::Show At the very least the class should be name-spaced correctly as Faker::Music::Show
Faker::Show is ambiguous for its current usage. Faker::Music::Show would also be ambiguous. The class supports three methods: adult_musical kids_musical play that generate names for musicals and plays which all can be categorized under Theater.
It helps with tracking down what was the reason behind the change.
Do you mean the commit message or the PR description? |
|
@stefannibrasil I have updated the PR description for it. Let me know if you need me to rewrite the commit message as well. |
the commit message is better, thanks! |
|
@stefannibrasil Can we merge this? |
| # @example | ||
| # Faker::Alphanumeric.alpha | ||
| # #=> "West Side Story" | ||
| # Faker::Theater.adult_musical |
2 participants
This Pull Request has been created because of naming issues identified here: #2787
This PR replaces the usage of Faker::Show to be Faker::Theater for the following reasons:
The file was created under faker/music/show.rb but the class definition is Faker::Show At the very least the class should be name-spaced correctly as Faker::Music::Show
Faker::Show is ambiguous for its current usage. Faker::Music::Show would also be ambiguous. The class supports three methods: adult_musical kids_musical play that generate names for musicals and plays which all can be categorized under Theater.
Checklist
Before submitting the PR make sure the following are checked:
[Fix #]If you're proposing a new generator or locale: