Tweaking Doctrine book chapter #3488
Closed
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
… with the new documentation standards Specifically, I'm pretending as if 2.1 had reached its end-of-life today, and am applying all the needed changes to the master branch
Update master for new documentation standards
[WCM] Documented ProgressHelper's clear() method.
…s been deprecated - see documentation release directions)
…eed an extension that helps us manage this version stuff
Conflicts: book/security.rst
…k on the 2.2 branch
adds docs for idle timeout (see symfony/symfony#8651)
[WCM] Updated documentation for PR symfony/symfony#849...
…urity-id [WCM][Security][Acl] Documentation for the new updateUserSecurityIdentity method in Dbal\MutableAclProvider
Conflicts: reference/forms/types/integer.rst reference/forms/types/number.rst
Conflicts: cookbook/form/dynamic_form_modification.rst
Conflicts: book/security.rst
* Tweaked language in the components section to be more useful for component people * Added versionadded * Tweaked description of how this feature works
[Form] added multiple option to file type doc
…iner::enterScope()
Conflicts: book/http_cache.rst
* 2.3: use html+jinja instead of html+twig
* 2.4: use html+jinja instead of html+twig
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.
|
see #3489 |
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.