Update doctrine.rst #6769
Closed
Update doctrine.rst #6769
Conversation
This file contains hidden or 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
Note for «see doctrine documentation» just in section where `inversedBy` and `mappedBy` were just read. I know that five sections below there is a **More Information on Associations** section where this is a reference to this (if you dig enough, because it's referenced to other page there), but that's not enough. It's too general and too late. When you're reading this (my case, as a newcomer right now) and get to this `inversedBy` and `mappedBy` here and there isn't any direct mention about it in **Relationship Mapping Metadata** section, you felt lost. Can't understand why that is really used and what it means. And you scroll and see no direct reference about that. It breaks your learning rhythm. I had to search about this, till I found the Doctrine's documentation that I linked in that note. That cleared out the doubt. So I can continue learning. Five sections away there's a general «Read more about associations». That's ok. I will read more then. But at that moment, you need, at least, to understand, at least superficially, why that parameters are there.
|
Hi @soulchainer! I agree with your proposal, I know I was confused for a long time about these 2 keywords as well. However, as we recently restructured the docs, this PR can't be merged as is. I've taken your commit, rebased it on the new docs and created #6849 . Your still the commit author, so you still get the credits :) Thanks! |
weaverryan
added a commit
that referenced
this pull request
Aug 21, 2016
…outerj) This PR was merged into the 2.7 branch. Discussion ---------- Link to inversedBy/mappedBy documentation Finishes #6769 Original description: > Note for «see doctrine's documentation» just in section where `inversedBy` and `mappedBy` first appeared > I know that five sections away there is a [More Information on Associations](https://symfony.com/doc/2.7/book/doctrine.html#more-information-on-associations) section, that has a reference to this (if you dig enough: it's linked in the page linked in that section), but that's not enough. It's too general and too late. > When you're reading this (my case, as a newcomer right now) and get to this `inversedBy` and `mappedBy` in [Relationship Mapping Metadata](https://symfony.com/doc/2.7/book/doctrine.html#relationship-mapping-metadata) section, and there isn't any direct mention about it, you felt lost. Can't understand why that's used and what it means. And you scroll and see no direct reference about that. It breaks your learning rhythm. I had to search about this, till I found the Doctrine's documentation that I linked in the added note. That cleared out the doubt. So I can continue learning. Five sections away there's a general «Read more about associations». That's OK. I will read more then. But at that moment, you need, at least, to understand why that parameters are there. Commits ------- e33b7f3 Minor unrelated spacing fixes af3adb8 Update doctrine.rst
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.
Note for «see doctrine's documentation» just in section where
inversedByandmappedByfirst appearedI know that five sections away there is a More Information on Associations section, that has a reference to this (if you dig enough: it's linked in the page linked in that section), but that's not enough. It's too general and too late.
When you're reading this (my case, as a newcomer right now) and get to this
inversedByandmappedByin Relationship Mapping Metadata section, and there isn't any direct mention about it, you felt lost. Can't understand why that's used and what it means. And you scroll and see no direct reference about that. It breaks your learning rhythm. I had to search about this, till I found the Doctrine's documentation that I linked in the added note. That cleared out the doubt. So I can continue learning. Five sections away there's a general «Read more about associations». That's OK. I will read more then. But at that moment, you need, at least, to understand why that parameters are there.