Minor edits to the AR guide #51333
Merged
Minor edits to the AR guide #51333
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
bhumi1102
reviewed
Mar 18, 2024
Comment on lines
+227
to
+230
| That migration creates columns `id`, `title`, `author`, `created_at` and | ||
| `updated_at`. Each row of this table can be represented by an instance of the | ||
| `Book` class with the same attributes: `id`, `title`, `author`, `created_at`, | ||
| and `updated_at`. You can access a book's attributes like this: |
There was a problem hiding this comment.
I like this. Listing all columns and attributes is more complete and clear. I went back and forth about how much to explain about how the created_at, updated_at and id are generated vs. the other columns.
👍 Thanks for the improvements @fxn. All of that makes sense. And thanks @carlosantoniodasilva for merging! |
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.
Hey @bhumi1102, awesome job in #51226!
I have made a pass over the guide to polish a few totally minor things. Let me explain some of them:
BookClubandbook_clubs, there's this pattern where you have a list item, a hyphen, and a sentence, that is found in other places in this guide. In the rest of them, the first letter of the sentence is written in upper case. We could put "Is" in upper case here, but I guess it is not quite right in English without a subject. I opted instead for removing the hyphen and making those items read like normal sentences, please let me know if you'd like a different option.comments_countwas worded in terms of columns of a Ruby class, but Ruby classes do not have columns. I just reworded a bit here.bookstable using the provided SQL has less columns, it is not creating the timestamps. I tried to reword the existing paragraph, but it was not very clear for my liking. I ended up moving the sentence about the SQL next to it, to then have more margin to describe the migration.createwill return the object and save it to the database", while that is correct, it is more natural for readers to have things enumerated in the order in which they happen: the method first saves the object, and then returns it.The rest is self-explanatory.
What do you think?