Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link to inversedBy/mappedBy documentation #6849

Merged
merged 2 commits into from
Aug 21, 2016

Conversation

wouterj
Copy link
Member

@wouterj wouterj commented Aug 5, 2016

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 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 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.

soulchainer and others added 2 commits August 5, 2016 11:23
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.
@weaverryan
Copy link
Member

This is excellent feedback and an excellent change. Thanks @soulchainer!

@weaverryan weaverryan merged commit e33b7f3 into symfony:2.7 Aug 21, 2016
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
@wouterj wouterj deleted the soulchainer-patch-2 branch August 21, 2016 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants