Small documentation updates #430
Conversation
|
The example I used for the I know this example is sprinkled across a few places in the docs, but when I was looking specifically at this section it was missing. So after figuring it out, I thought it would be good to add :) |
… when running `crystal spec` and added the `pool_size` configuration to the configuration block example
| belongs_to :person, foreign: :guid, primary: guid | ||
|
|
||
| # In this example model, the `type` field is a string of "mailing_address" or "physical_address" | ||
| mapping( |
There was a problem hiding this comment.
Do you prefer to have mapping at the bottom of the class? Is it because it leaves more space for other information at the top of the file? Did you tested it with MTI?
There was a problem hiding this comment.
This example came from how I was able to get Jennifer working with a DB that was already configured to work this way in a Rails app. It didn't properly use STI, but kind of mocked the behavior.
As far as where the mapping macro goes, I like to organize my models so the relationship definitions are at the top of the file, the mapping macro goes below that to make seeing the fields easy, and below that, I define any model methods. Just a personal preference because it makes finding relationships quick and easy.
There was a problem hiding this comment.
Currently all examples follow the opposite notation - mapping first and relations next. Could you please change the order here so it is consistent with other pages?
What does this PR do?
Adds an example for how to use the
requestparameter on relationships, and a few minor wording changes that improve the readability of the docs.