treewide: Rename ReadySet to Readyset
#39
Merged
Conversation
This file contains 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
Originally, we thought it would make more sense to name our primary module `ReadySet`, since that is how the word "ReadySet" is stylized elsewhere. However, this forced us to change the name of `lib/readyset`/`lib/readyset.rb` to `lib/ready_set`/`lib/ready_set.rb`. Because the name of our gem is "readyset" (and not "ready_set"), this broke Rails's autoloading feature, which meant users had to add `require: 'ready_set'` in their Gemspec to get our gem loaded correctly. Given all of this, this commit changes the name of the `ReadySet` module back to `Readyset`, which allows us to keep our gem named "readyset" while still allowing autoloading to take place.
|
@helpotters You were right about this -- |
|
Aesthetically, it hurts to write Readyset. Practical, but painful. |
helpotters
approved these changes
Nov 30, 2023
helpotters
added a commit
that referenced
this pull request
Dec 1, 2023
Originally, we thought it would make more sense to name our primary module `ReadySet`, since that is how the word "ReadySet" is stylized elsewhere. However, this forced us to change the name of `lib/readyset`/`lib/readyset.rb` to `lib/ready_set`/`lib/ready_set.rb`. Because the name of our gem is "readyset" (and not "ready_set"), this broke Rails's autoloading feature, which meant users had to add `require: 'ready_set'` in their Gemspec to get our gem loaded correctly. Given all of this, this commit changes the name of the `ReadySet` module back to `Readyset`, which allows us to keep our gem named "readyset" while still allowing autoloading to take place.
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.
Originally, we thought it would make more sense to name our primary module
ReadySet, since that is how the word "ReadySet" is stylized elsewhere. However, this forced us to change the name oflib/readyset/lib/readyset.rbtolib/ready_set/lib/ready_set.rb. Because the name of our gem is "readyset" (and not "ready_set"), this broke Rails's autoloading feature, which meant users had to addrequire: 'ready_set'in their Gemspec to get our gem loaded correctly.Given all of this, this commit changes the name of the
ReadySetmodule back toReadyset, which allows us to keep our gem named "readyset" while still allowing autoloading to take place.