Tweaking Doctrine book chapter #3490
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
The doctrine docs already has a big great documentation on this. There is no reason to duplicate it in the sf docs. This commit removes everything except a simple example. It also moves the sentence about the return result above, since that makes more sense now the getSingleResult example is removed.
The list is also included in the doctrine docs. There is no need to duplicate that in the sf docs. And if it's usefull, it certainly isn't when there is no more documentation about their meaning.
It's enough to add it to the "Read more" list, there is no need to introduce each cookbook article in a seperate section.
This is really doctrine specific, the sf docs should not document this, kind of SoC for docs 😉.
It's not really basic information. All important commands are already discussed in the rest of the chapter. The rest are just usefull commands, which is a perfect topic for a cookbook.
| @@ -1598,10 +1379,12 @@ that allow you to take different actions as objects go through their persistence | |||
| lifecycle. | |||
|
|
|||
| For more information about Doctrine, see the *Doctrine* section of the | |||
| :doc:`cookbook </cookbook/index>`, which includes the following articles: | |||
| :doc:`cookbook </cookbook/index>`. Some usefull articles might be: | |||
|
Hey Wouter! I've just added some comments, but it's really wonderful. Thanks for doing this in small pieces - your PR - though large - is very very easy to understand and I have no big worries at all about people getting lost because we've moved too much. As you see things, please continue making these PR's, because they are great. And if we do them little by little, it will be clear whether or not we are changing things so much they're difficult to find for returning people. Thanks! |
It's now smaller (25 to 3 lines) and uses getOneOrNullResult().
The QueryBuilder seems to be easier and more recommend to use. This meant the QueryBuilder section now contains the primary information and the DQL section is now reduced to somewhat a "side topic".
|
@wouterj can you rebase? I promise I'll merge it quickly to avoid conflicts once you do ;) |
|
Actually, nevermind - I forgot that gh handles merges just fine (unless we need to also change the branch we're merging into). Thanks so much again @wouterj! |
weaverryan
added a commit
that referenced
this pull request
Mar 4, 2014
This PR was merged into the 2.3 branch. Discussion ---------- Tweaking Doctrine book chapter The doctrine book chapter is a really long chapter, so long I haven't finished it in my 2 years of sf docs experience ;-). I decided to put some time in it to make it somewhat smaller. I planned to do more significant changes, but I think that'll confuse people. I already think these changes can confuse people, as they might look for that documentation in the book chapter, while it was moved to another article or even completely removed. But that might be a first good testcase for our CHANGELOG plan 😉 But I think it's good to invest time to make our book easy to read again. I've worked very precise with commits, in order to easy revert something and in order to document why I did some changes. If you want some clarification on some changes, you can read it in the long commit description. | Q | A | --- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | - Commits ------- b4dd1a1 Fixed typo + added remore section 7af962c Rephrased Field Type section 79e2216 Rephrased linking paragraph for Lifecycle events 20ba9e0 Readded small note about parameters 8bb3195 Fixed spelling 91a18cd Changed order to QueryBuilder -> DQL 7acc0d2 Reverted removal of getSingleResult() c98a3da Adjusted doctrine service tip f7ec98c Added tip at a more logical place 034d69a Tweaked new cookbook article 18cbacd Clean up reference pointers list 2af5c60 Small tweaks to summary 2c68f04 Moved commands to cookbook 88aa347 Removed types list c95a68d Removed "Doctrine Extensions" section 13edbcc Removed some duplicated Livecycle docs 22bb029 Minor tweak to configuration section 1ec68fe Minor tweaks to Repository section 485b529 Removed duplicated DQL documentation
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.
The doctrine book chapter is a really long chapter, so long I haven't
finished it in my 2 years of sf docs experience ;-). I decided to put
some time in it to make it somewhat smaller.
I planned to do more significant changes, but I think that'll confuse
people. I already think these changes can confuse people, as they might
look for that documentation in the book chapter, while it was moved to
another article or even completely removed. But that might be a first
good testcase for our CHANGELOG plan 😉
But I think it's good to invest time to make our book easy to read
again.
I've worked very precise with commits, in order to easy revert something
and in order to document why I did some changes. If you want some
clarification on some changes, you can read it in the long commit
description.