Skip to content

Tweaking Doctrine book chapter #3489

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

Closed
wants to merge 40 commits into from

Conversation

wouterj
Copy link
Member

@wouterj wouterj commented Jan 18, 2014

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 -

xabbuh and others added 30 commits January 3, 2014 12:50
…me/datetime option (bicpi)

This PR was merged into the 2.3 branch.

Discussion
----------

[Reference][Form Types] Document "with_minutes" time/datetime option

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | yes
| Applies to    | 2.3+
| Fixed tickets | symfony#3410 (task `time > with_minutes`)

The `datetime` field also has a `with_minutes` option.

Using the `single_text` widget type might not work as expected using `with_minutes=false` if the browser supports HTML5's `time` input type. Most browsers seem to only support `hh:mm` or `hh:mm:ss` formats for the value attribute (resetting the value to `--:--` if using an hour value only). This might not be the case for every browser because I couldn't find anything in the HTML5 spec that says a partial time cannot be an hour only. I've added a `caution` box for this.

Commits
-------

1e88b9d Fix "versionadded" position
8cfb850 [Reference][Form Types] Document "with_minutes" time/datetime option
| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | 2.3
| Fixed tickets | symfony#3442
I just mentioned the fact that `push -f` is usually required when rebasing and explicit that the "2.2 when bugfixing" is a follow up on the previous example (Not necessarily explicit at first).
…ote of warning for when forbidding anonymous users (cordoval)

This PR was merged into the 2.3 branch.

Discussion
----------

[Cookbook][Custom Authentication Provider] add a note of warning for when forbidding anonymous users

| Q             | A                   |
| ---           | ---                 |
| Doc fix?      | yes                 |
| New docs?     | no                  |
| Applies to    | 2.3+                |
| Fixed tickets | symfony#3212               |
| License       | CC-ASA 3.0 Unported |

 Sent using [Gush](https://github.com/cordoval/gush)

Commits
-------

244d756 add note when forbidding access to anonymous users on custom authentication provider
…ion save handler proxies (cordoval)

This PR was merged into the 2.3 branch.

Discussion
----------

[Session Configuration] add clarifying notes on session save handler proxies

| Q             | A                   |
| ---           | ---                 |
| Doc fix?      | yes                 |
| New docs?     | no                  |
| Applies to    | 2.3+                |
| Fixed tickets | symfony#2889               |
| License       | CC-ASA 3.0 Unported |

 Sent using [Gush](https://github.com/cordoval/gush)

Commits
-------

771b862 address comments from @wouterj
2888d00 answer some questions and clarify the best chapter imo from the symfony documentation
…orm type (nykopol)

This PR was merged into the 2.3 branch.

Discussion
----------

[Reference][Form Types] Add "max_length" option in form type

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | yes
| Applies to    | 2.3+
| Fixed tickets | symfony#3410 (task Form -> max_length)

Commits
-------

b53a227 fix last typo on max length option
d6800d3 fix typo in previous commit
391fe30 fix typo in previous commit
2156545 add max_length to form field type
This PR was merged into the 2.3 branch.

Discussion
----------

add missing code-block directive

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets |

Commits
-------

9b1aab8 add missing code-block directive
…ced in 2.4 (xabbuh)

This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes symfony#3415).

Discussion
----------

[symfony#3334] the data_class option was not introduced in 2.4

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets |

Commits
-------

c96e6eb [symfony#3334] the data_class option was not introduced in 2.4
…d (xabbuh)

This PR was merged into the 2.3 branch.

Discussion
----------

add empty_data option where required option is used

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets |

Commits
-------

d9c6a85 add empty_data option where required option is used
…tion (danielcsgomes)

This PR was merged into the 2.3 branch.

Discussion
----------

Removed code references to Symfony Standard Distribution

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | 2.3+
| Fixed tickets |

After talk with @wouterj on symfony#3426 and IRC about references in the standalone Console component to the framework I decided to submit this PR to change the code that have some references to the Symfony Standard Distribution in the code.

Commits
-------

4fd7022 Removed code references to Symfony Standard Distribution
This PR was merged into the 2.3 branch.

Discussion
----------

Fix issue symfony#3442

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | 2.3
| Fixed tickets | symfony#3442

Commits
-------

559a227 Fix issue symfony#3442
weaverryan and others added 10 commits January 10, 2014 08:02
This PR was merged into the 2.3 branch.

Discussion
----------

Overridden tweak

Hi guys!

Tiny change (so skipping the PR table) - see symfony#3407 (comment)

Thanks!

Commits
-------

8f3e6c7 [symfony#3407] Adding a missing section via tip from @wouterj
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.
@wouterj
Copy link
Member Author

wouterj commented Jan 18, 2014

Well, I think I'm a bit dizzy today, third try: #3490

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants